Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

No links to inherited items in summary tables #50

Open
andy-maier opened this issue Apr 18, 2021 · 5 comments
Open

No links to inherited items in summary tables #50

andy-maier opened this issue Apr 18, 2021 · 5 comments

Comments

@andy-maier
Copy link

andy-maier commented Apr 18, 2021 •
edited
Loading

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.
andy-maier added a commit to pywbem/pywbem that referenced this issue Apr 18, 2021
@andy-maier
Used 'autodocsumm' Sphinx extension; moved base classes to appendix; …
abfc800 
…other fixes

Details:

* Used the 'autodocsumm' Sphinx extension for generating attribute and method
  summary tables for classes in the documentation. At this point, links to
  inherited members are not generated. See autodocsumm issue
  Chilipp/autodocsumm#50.

* Moved the documentation of some base classes into a new 'Base Classes' section
  in the Appendix:
  - from pywbem_mock: BaseRepository, BaseObjectStore, BaseProvider.
  - from pywbem._exceptions: _RequestExceptionMixin, _ResponseExceptionMixin
  - from pywbem._cim_types: _CIMComparisonMixin

* Removed the internal classes '_RequestExceptionMixin', '_ResponseExceptionMixin'
  from the pywbem namespace.

* Excluded the internal operation recorder related attributes and methods
  from the documentation of WBEMConnection.

* Added a docstring to CIMDateTime.__eq__().

* Removed the superflous phrase "in descending precedence" from the docstrings of
  the __eq__() methods of CIM object classes.

* Added an empty docstring to special methods that are in the documentation,
  because otherwise they get their description inherited.

* Minor fixes in description of exceptions regarding TypeError being raised.

* Minor fixes in formatting in module docstring of mockwbemserver.rst.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
andy-maier added a commit to pywbem/pywbem that referenced this issue Apr 18, 2021
@andy-maier
Used 'autodocsumm' Sphinx extension; moved base classes to appendix; …
dd2f66a 
…other fixes

Details:

* Used the 'autodocsumm' Sphinx extension for generating attribute and method
  summary tables for classes in the documentation. At this point, links to
  inherited members are not generated. See autodocsumm issue
  Chilipp/autodocsumm#50.

* Moved the documentation of some base classes into a new 'Base Classes' section
  in the Appendix:
  - from pywbem_mock: BaseRepository, BaseObjectStore, BaseProvider.
  - from pywbem._exceptions: _RequestExceptionMixin, _ResponseExceptionMixin
  - from pywbem._cim_types: _CIMComparisonMixin

* Removed the internal classes '_RequestExceptionMixin', '_ResponseExceptionMixin'
  from the pywbem namespace.

* Excluded the internal operation recorder related attributes and methods
  from the documentation of WBEMConnection.

* Added a docstring to CIMDateTime.__eq__().

* Removed the superflous phrase "in descending precedence" from the docstrings of
  the __eq__() methods of CIM object classes.

* Added an empty docstring to special methods that are in the documentation,
  because otherwise they get their description inherited.

* Minor fixes in description of exceptions regarding TypeError being raised.

* Minor fixes in formatting in module docstring of mockwbemserver.rst.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
andy-maier added a commit to pywbem/pywbem that referenced this issue Apr 18, 2021
@andy-maier
Used 'autodocsumm' Sphinx extension; moved base classes to appendix; …
961ce6e 
…other fixes

Details:

* Used the 'autodocsumm' Sphinx extension for generating attribute and method
  summary tables for classes in the documentation. At this point, links to
  inherited members are not generated. See autodocsumm issue
  Chilipp/autodocsumm#50.

* Moved the documentation of some base classes into a new 'Base Classes' section
  in the Appendix:
  - from pywbem_mock: BaseRepository, BaseObjectStore, BaseProvider.
  - from pywbem._exceptions: _RequestExceptionMixin, _ResponseExceptionMixin
  - from pywbem._cim_types: _CIMComparisonMixin

* Removed the internal classes '_RequestExceptionMixin', '_ResponseExceptionMixin'
  from the pywbem namespace.

* Excluded the internal operation recorder related attributes and methods
  from the documentation of WBEMConnection.

* Added a docstring to CIMDateTime.__eq__().

* Removed the superflous phrase "in descending precedence" from the docstrings of
  the __eq__() methods of CIM object classes.

* Added an empty docstring to special methods that are in the documentation,
  because otherwise they get their description inherited.

* Minor fixes in description of exceptions regarding TypeError being raised.

* Minor fixes in formatting in module docstring of mockwbemserver.rst.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
andy-maier added a commit to pywbem/pywbem that referenced this issue Apr 18, 2021
@andy-maier
Used 'autodocsumm' Sphinx extension; moved base classes to appendix; …
beb7647 
…other fixes

Details:

* Used the 'autodocsumm' Sphinx extension for generating attribute and method
  summary tables for classes in the documentation. At this point, links to
  inherited members are not generated. See autodocsumm issue
  Chilipp/autodocsumm#50.

* Moved the documentation of some base classes into a new 'Base Classes' section
  in the Appendix:
  - from pywbem_mock: BaseRepository, BaseObjectStore, BaseProvider.
  - from pywbem._exceptions: _RequestExceptionMixin, _ResponseExceptionMixin
  - from pywbem._cim_types: _CIMComparisonMixin

* Removed the internal classes '_RequestExceptionMixin', '_ResponseExceptionMixin'
  from the pywbem namespace.

* Excluded the internal operation recorder related attributes and methods
  from the documentation of WBEMConnection. This could only be done by using
  the autodocsumm extension. See docs/client/operations.rst.

* Added a docstring to CIMDateTime.__eq__().

* Removed the superflous phrase "in descending precedence" from the docstrings of
  the __eq__() methods of CIM object classes.

* Added an empty docstring to special methods that are in the documentation,
  because otherwise they get their description inherited.

* Minor fixes in description of exceptions regarding TypeError being raised.

* Minor fixes in formatting in module docstring of mockwbemserver.rst.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
andy-maier added a commit to pywbem/pywbem that referenced this issue Apr 21, 2021
@andy-maier
Used 'autodocsumm' Sphinx extension; moved base classes to appendix; …
96988b5 
…other fixes

Details:

* Used the 'autodocsumm' Sphinx extension for generating attribute and method
  summary tables for classes in the documentation. At this point, links to
  inherited members are not generated. See autodocsumm issue
  Chilipp/autodocsumm#50.

* Moved the documentation of some base classes into a new 'Base Classes' section
  in the Appendix:
  - from pywbem_mock: BaseRepository, BaseObjectStore, BaseProvider.
  - from pywbem._exceptions: _RequestExceptionMixin, _ResponseExceptionMixin
  - from pywbem._cim_types: _CIMComparisonMixin

* Removed the internal classes '_RequestExceptionMixin', '_ResponseExceptionMixin'
  from the pywbem namespace.

* Excluded the internal operation recorder related attributes and methods
  from the documentation of WBEMConnection. This could only be done by using
  the autodocsumm extension. See docs/client/operations.rst.

* Added a docstring to CIMDateTime.__eq__().

* Removed the superflous phrase "in descending precedence" from the docstrings of
  the __eq__() methods of CIM object classes.

* Added an empty docstring to special methods that are in the documentation,
  because otherwise they get their description inherited.

* Minor fixes in description of exceptions regarding TypeError being raised.

* Minor fixes in formatting in module docstring of mockwbemserver.rst.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
andy-maier added a commit to pywbem/pywbem that referenced this issue Apr 21, 2021
@andy-maier
Used 'autodocsumm' Sphinx extension; moved base classes to appendix; …
2335db6 
…other fixes

Details:

* Used the 'autodocsumm' Sphinx extension for generating attribute and method
  summary tables for classes in the documentation. At this point, links to
  inherited members are not generated. See autodocsumm issue
  Chilipp/autodocsumm#50.

* Moved the documentation of some base classes into a new 'Base Classes' section
  in the Appendix:
  - from pywbem_mock: BaseRepository, BaseObjectStore, BaseProvider.
  - from pywbem._exceptions: _RequestExceptionMixin, _ResponseExceptionMixin
  - from pywbem._cim_types: _CIMComparisonMixin

* Removed the internal classes '_RequestExceptionMixin', '_ResponseExceptionMixin'
  from the pywbem namespace.

* Excluded the internal operation recorder related attributes and methods
  from the documentation of WBEMConnection. This could only be done by using
  the autodocsumm extension. See docs/client/operations.rst.

* Added a docstring to CIMDateTime.__eq__().

* Removed the superflous phrase "in descending precedence" from the docstrings of
  the __eq__() methods of CIM object classes.

* Added an empty docstring to special methods that are in the documentation,
  because otherwise they get their description inherited.

* Minor fixes in description of exceptions regarding TypeError being raised.

* Minor fixes in formatting in module docstring of mockwbemserver.rst.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
@Chilipp
Copy link
Owner

Chilipp commented May 9, 2021

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

@Chilipp
Copy link
Owner

Chilipp commented Apr 19, 2022

@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
Copy link
Author

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 pywbem/pywbem#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
Copy link
Author

andy-maier commented Jun 19, 2022 •
edited
Loading

@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 andy-maier mentioned this issue Jun 19, 2022
Closed
This was referenced Jul 24, 2022
Open
Open
@andy-maier
Copy link
Author

andy-maier commented Jul 24, 2022 •
edited
Loading

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

@andy-maier andy-maier mentioned this issue Oct 15, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@andy-maier @Chilipp