search

Chilipp / autodocsumm

Extending your autodoc API docs with a summary
Apache License 2.0
48 stars 14 forks source link

No links to inherited items in summary tables #50

Open andy-maier opened 3 years ago

andy-maier commented 3 years ago

If the :autosummary-inherited-members: option is used on a class, the attribute and method summary tables generated by autodocsumm correctly include items for the inherited attributes and methods, but these items do not link to their descriptions. Their descriptions are in the same overall Sphinx document. That happens regardless of whether their descriptions are in the same or another RST file.

I verified that I can get working links to the inherited members properly generated with the :attr: and :meth: directives in the same RST file that specifies the autoclass directive, so the targeted members are visible from there at the Sphinx reference level.

Chilipp commented 3 years ago

hey @andy-maier! apologies for the delay. I'd need more information to fix this. Could you please provide a small reproducible example?

Chilipp commented 2 years ago

@andy-maier I assume that this issue is fixed by #70. could you please give it a try with autodocsumm==0.2.8 and close this issue if this is fixed?

andy-maier commented 2 years ago

Hi @Chilipp . Sorry for the delay. I will try with autodocsumm==0.2.8 and will produce a short file to reproduce it.

Note that #74 is likely related to that, IMO. The issue author also opened https://github.com/pywbem/pywbem/issues/2888 which includes some of the same errors. That lead me to start using the -n option of sphinx-build now. i was able to fix most of the reference not found issues due to errors in our project, but the ones that remained at the end are exactly those I reported here in this issue.

andy-maier commented 2 years ago

@Chilipp I was able to reproduce the issue with autodocsumm 0.2.8 and a simple case. Unpack the attached file and read README.md inside:

autodocsumm_50.zip

In the included conf.py, I added the main directory of the zip file to the Python module search path, but that was just for convenience so that the module did not need to be installed as a Python package. I'm pretty sure that installing it as a package does not let the error go away (I tried this with the pywbem project). But if you have doubts about this and want me to provide an installable package, let me know.

andy-maier commented 2 years ago

Hi Philipp. I have done some more research, and meanwhile believe this is a Sphinx issue, and have created https://github.com/sphinx-doc/sphinx/issues/10699. If you think differently, let me know.