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.

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

Docs: Inherited attributes and methods have no links in overview tables #998

Open
andy-maier opened this issue Jun 12, 2022 · 5 comments
Open

Comments

@andy-maier
Copy link
Member

The zhmcclient classes show inherited elements in the documentation in the "Attributes" and "Methods" overview tables. However, their names in these tables are not links, like it is the case for locally defined properties and methods.

Example: In https://python-zhmcclient.readthedocs.io/en/latest/resources.html#zhmcclient.Partition :

  • The locally defined nics item in the "Attributes" table is a link
  • The inherited full_properties item in the "Attributes" table is not a link
@andy-maier
Copy link
Member Author

andy-maier commented Jul 24, 2022

The same issue in pywbem was reported to the autodocsumm project as Chilipp/autodocsumm#50.

Meanwhile I think this is a Sphinx issue, see sphinx-doc/sphinx#10699

@andy-maier andy-maier removed this from the 1.4.0 milestone Jul 24, 2022
@andy-maier
Copy link
Member Author

I removed this from 1.4.0 since a fix supposedly requires a new Sphinx version

@andy-maier
Copy link
Member Author

Need to wait for Sphinx to look at the issue, and to pick up a possible fix in Sphinx.

@andy-maier andy-maier added this to the 1.14.0 milestone Jan 12, 2024
@andy-maier
Copy link
Member Author

At this point, the Sphinx issue has not been resolved.

@andy-maier andy-maier modified the milestones: 1.14.0, 1.15.0 Feb 17, 2024
@andy-maier andy-maier modified the milestones: 1.15.0, 1.16.0, 1.17.0 Jun 7, 2024
@andy-maier
Copy link
Member Author

The Sphinx issue is not yet resolved - moving this to the next zhmcclient milestone.

@andy-maier andy-maier modified the milestones: 1.17.0, 1.18.0 Jun 27, 2024
@andy-maier andy-maier modified the milestones: 1.18.0, 1.19.0 Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant