Skip to content
Snippets Groups Projects
Commit ba16fb5d authored by Frederik Hennig's avatar Frederik Hennig
Browse files

add type system inheritance diagram to docs

parent 8a4a65b9
No related branches found
No related tags found
2 merge requests!379Type System Refactor,!374Uniqueness of Data Type Instances
Pipeline #64903 passed
...@@ -17,6 +17,10 @@ Basic Functions ...@@ -17,6 +17,10 @@ Basic Functions
Data Type Class Hierarchy Data Type Class Hierarchy
------------------------- -------------------------
.. inheritance-diagram:: pystencils.types.meta.PsType pystencils.types.types
:top-classes: pystencils.types.PsType
:parts: 1
.. autoclass:: pystencils.types.PsType .. autoclass:: pystencils.types.PsType
:members: :members:
......
...@@ -29,6 +29,7 @@ extensions = [ ...@@ -29,6 +29,7 @@ extensions = [
"sphinx.ext.intersphinx", "sphinx.ext.intersphinx",
"sphinx.ext.mathjax", "sphinx.ext.mathjax",
"sphinx.ext.napoleon", "sphinx.ext.napoleon",
"sphinx.ext.inheritance_diagram",
"nbsphinx", "nbsphinx",
"sphinxcontrib.bibtex", "sphinxcontrib.bibtex",
"sphinx_autodoc_typehints", "sphinx_autodoc_typehints",
...@@ -47,6 +48,12 @@ intersphinx_mapping = { ...@@ -47,6 +48,12 @@ intersphinx_mapping = {
"sympy": ("https://docs.sympy.org/latest/", None), "sympy": ("https://docs.sympy.org/latest/", None),
} }
# -- Options for inheritance diagrams-----------------------------------------
inheritance_graph_attrs = {
"bgcolor": "white",
}
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
html_theme = "furo" html_theme = "furo"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment