Cross references in docs#43
Merged
justusschock merged 6 commits intomainfrom Mar 20, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
:show-inheritance:directive to theFile,Image,Text,Model,Series,MediaType,PhaseType,MetricValue, andMetricsclass documentation indocs/source/api.rstto explicitly show their inheritance hierarchies. [1] [2] [3]Sphinx configuration update:
show-inheritanceoption toFalseby default indocs/source/conf.py, so inheritance will only be shown where explicitly requested in the API docs.