-
-
Notifications
You must be signed in to change notification settings - Fork 529
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
Generate inheritance diagrams for models and submodels in the documentation #3074
Generate inheritance diagrams for models and submodels in the documentation #3074
Conversation
generated using graphviz and sphinxext-inheritance_diagram
Moves sphinxcontrib.bibtex configuration to correct position (in order to cause less merge conflicts) Adds other local Sphinx extensions inside docs/ Configures options for graphviz edges and nodes
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## develop #3074 +/- ##
===========================================
- Coverage 99.71% 99.71% -0.01%
===========================================
Files 248 248
Lines 18749 18747 -2
===========================================
- Hits 18695 18693 -2
Misses 54 54
☔ View full report in Codecov by Sentry. |
The built docs can be checked here: https://pybamm--3074.org.readthedocs.build/en/3074/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks, looks good
…uppress warning
Description
Adds a Sphinx autodoc extension that appends inheritance diagrams for models and submodels classes in their docstrings, using a dropdown from sphinx-design, and sphinx.ext.inheritance_diagram – which uses
graphviz
to generate a unidirectional graph in.SVG
format that displays derived classes for a particular class.Type of change
Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.
Key checklist:
$ pre-commit run
(see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)$ python run-tests.py --all
$ python run-tests.py --doctest
You can run unit and doctests together at once, using
$ python run-tests.py --quick
.Further checks: