Add option include-subclasses to inheritance-diagram. #8159
Conversation
This file contains 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
AA-Turner
added
the
extensions:graphviz
# Conflicts: # sphinx/ext/inheritance_diagram.py
# for free
to subscribe to this conversation on GitHub.
Already have an account?
#.
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 patch adds the following new feature to sphinx:
inheritance-diagramgains a new option:include-subclasses:.When this option is given, not only the classes listed as arguments to
inheritance-diagramare included in the diagram, but all sub classes (and their sub classes etc.) as well.This makes it possible to generate a complete inheritance tree by just listing the base class and adding
:include-subclasses:.This is different from specifying the module that contains this base class, as this module might include other classes that should not be part of the diagram.
Closes #8191