Skip to content
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

Merged

Conversation

agriyakhetarpal
Copy link
Member

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.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all
  • The documentation builds: $ python run-tests.py --doctest

You can run unit and doctests together at once, using $ python run-tests.py --quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

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
Copy link

codecov bot commented Jun 28, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.01 ⚠️

Comparison is base (c494873) 99.71% compared to head (109adce) 99.71%.

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              
Impacted Files Coverage Δ
pybamm/input/parameters/lithium_ion/Prada2013.py 100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@agriyakhetarpal
Copy link
Member Author

The built docs can be checked here: https://pybamm--3074.org.readthedocs.build/en/3074/

Copy link
Member

@valentinsulzer valentinsulzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, looks good

docs/sphinxext/inheritance_diagram.py Outdated Show resolved Hide resolved
@valentinsulzer valentinsulzer merged commit 5486fce into pybamm-team:develop Jul 6, 2023
16 of 19 checks passed
@agriyakhetarpal agriyakhetarpal deleted the sphinxext-inheritance-diag branch July 6, 2023 20:55
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this pull request Jul 8, 2023
@agriyakhetarpal agriyakhetarpal mentioned this pull request Jul 8, 2023
8 tasks
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.

3 participants