setup exhale

Author: schmoelder

doc/conf.py

@@ -31,6 +31,8 @@
     'sphinx_sitemap',
     'sphinxcontrib.bibtex',
     'sphinx_multiversion',
+    'breathe',
+    'exhale',
 ]
 
 # Bibliography
@@ -43,6 +45,28 @@
 smv_remote_whitelist = r"^origin$"          # Use branches from remote origin
 smv_outputdir_format = '{ref.name}'         # Use the branch/tag name
 
+# Setup the breathe extension
+breathe_projects = {
+    "CADET": "./doxyoutput/xml"
+}
+breathe_default_project = "CADET"
+
+# Setup the exhale extension
+exhale_args = {
+    # These arguments are required
+    "containmentFolder":     "./api",
+    "rootFileName":          "library_root.rst",
+    "rootFileTitle":         "Library API",
+    "doxygenStripFromPath":  "..",
+    # Suggested optional arguments
+    "createTreeView":        True,
+    # TIP: if using the sphinx-bootstrap-theme, you need
+    # "treeViewIsBootstrap": True,
+    "exhaleExecutesDoxygen": True,
+    "exhaleDoxygenStdin":    "INPUT = ../include",
+    "verboseBuild": True,
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

doc/index.rst

@@ -95,9 +95,10 @@ To cite CADET please use the following publication:
     simulation/index
     interface/index
     .. examples/index
+	api/library_root
     CADET-Match <https://cadet.github.io/CADET-Match/master/index.html>
     license
     zbibliography
     Legal notice <https://www.fz-juelich.de/portal/EN/Service/LegalNotice/_node.html>
 
-
+.. todolist::