Add graphviz for manual inheritance diagrams

MRChemSoft · Sep 26, 2023 · 074371d · 074371d
1 parent f9b2a1e
commit 074371d
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,7 +33,11 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.mathjax', 'breathe']
+extensions = [
+    'breathe',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.graphviz',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/index.rst b/docs/index.rst
@@ -42,7 +42,7 @@ The code can be found on `GitHub <https://github.com/MRChemSoft/mrcpp>`_.
 
 .. toctree::
    :maxdepth: 2
-   :caption: Programmer's Manual 
+   :caption: Programmer's Manual
 
    programmers_manual/overview
    programmers_manual/clang_tidy.rst
diff --git a/docs/programmers_manual/MWNode.rst b/docs/programmers_manual/MWNode.rst
@@ -2,9 +2,16 @@
 MWNode
 ---------------------
 
-This is an introduction to the mwtree class. We write a small overarching summary of the class where we define the 
+This is an introduction to the mwtree class. We write a small overarching summary of the class where we define the
 algorithm/equation/structure reasoning for having this class or where it fits with the rest of the code.
 
+.. graphviz::
+
+   digraph trees {
+       "MWNode" -> "FunctionNode"
+       "MWNode" -> "OperatorNode"
+   }
+
 .. doxygenclass:: mrcpp::MWNode
    :members:
    :protected-members:

diff --git a/docs/programmers_manual/MWTree.rst b/docs/programmers_manual/MWTree.rst
@@ -1,11 +1,19 @@
 ------------------
-MWTree 
+MWTree
 ------------------
 
-This is an introduction to the mwtree class. We write a small overarching summary of the class where we define the 
+This is an introduction to the mwtree class. We write a small overarching summary of the class where we define the
 algorithm/equation/structure reasoning for having this class or where it fits with the rest of the code.
 
+.. graphviz::
+
+   digraph trees {
+       "MWTree" -> "FunctionTree"
+       "MWTree" -> "OperatorTree"
+   }
+
 .. doxygenclass:: mrcpp::MWTree
    :members:
    :protected-members:
-   :private-members:
+   :private-members:
+