python-zhmcclient icon indicating copy to clipboard operation
python-zhmcclient copied to clipboard

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

Open andy-maier opened this issue 3 years ago • 5 comments

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 avatar Jun 12 '22 14:06 andy-maier

The same issue in pywbem was reported to the autodocsumm project as https://github.com/Chilipp/autodocsumm/issues/50.

Meanwhile I think this is a Sphinx issue, see https://github.com/sphinx-doc/sphinx/issues/10699

andy-maier avatar Jul 24 '22 10:07 andy-maier

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

andy-maier avatar Jul 24 '22 11:07 andy-maier

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

andy-maier avatar Aug 12 '22 08:08 andy-maier

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

andy-maier avatar Feb 17 '24 05:02 andy-maier

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

andy-maier avatar Jun 27 '24 11:06 andy-maier