Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
sphinx: activate the todos
[simgrid.git] / docs / source / conf.py
index ddca903e1ae898c1cc0bcd9b881b38e4075cf0ce..452d833e7bb6d0ca36ea1237a74572ff31620def 100644 (file)
@@ -39,15 +39,34 @@ release = u'3.21'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinx.ext.todo',
 #    'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
 #    'sphinx.ext.ifconfig',
     'breathe',
+    'exhale',
 ]
 
-breathe_projects = { 'simgrid': '../doc/xml' }
+todo_include_todos = True
+
+breathe_projects = { 'simgrid': '../../doc/xml' }
 breathe_default_project = "simgrid"
+
+# Setup the exhale extension
+exhale_args = {
+    # These arguments are required
+    "containmentFolder":     "./api",
+    "rootFileName":          "library_root.rst",
+    "rootFileTitle":         "SimGrid Full API",
+    "doxygenStripFromPath":  "..",
+    # Suggested optional arguments
+    "createTreeView":        True,
+    # TIP: if using the sphinx-bootstrap-theme, you need
+    # "treeViewIsBootstrap": True,
+    "exhaleExecutesDoxygen": False,
+    # "exhaleDoxygenStdin":    "INPUT = ../../include"
+}
+
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']