Skip to content

Cross references in docs#43

Merged
justusschock merged 6 commits intomainfrom
cross_references_in_docs
Mar 20, 2026
Merged

Cross references in docs#43
justusschock merged 6 commits intomainfrom
cross_references_in_docs

Conversation

@justusschock
Copy link
Copy Markdown
Member

@justusschock justusschock commented Mar 20, 2026

This pull request makes several documentation improvements to the Sphinx API docs by ensuring that class inheritance hierarchies are displayed in the generated documentation for key classes, while also updating the default inheritance display setting. The main focus is on making the inheritance structure of important classes more visible and clear for users reading the documentation.

Documentation improvements:

  • Added the :show-inheritance: directive to the File, Image, Text, Model, Series, MediaType, PhaseType, MetricValue, and Metrics class documentation in docs/source/api.rst to explicitly show their inheritance hierarchies. [1] [2] [3]

Sphinx configuration update:

  • Set the show-inheritance option to False by default in docs/source/conf.py, so inheritance will only be shown where explicitly requested in the API docs.

@justusschock justusschock merged commit de8fbfa into main Mar 20, 2026
56 checks passed
@justusschock justusschock deleted the cross_references_in_docs branch March 20, 2026 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant