chore: add example of how to setup breathe

abdes · Apr 19, 2023 · 1d15b95 · 1d15b95
1 parent 9bfdd7e
commit 1d15b95
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/doc/conf.py.in b/doc/conf.py.in
@@ -48,9 +48,16 @@ extensions = [
     'sphinx.ext.viewcode',
     'sphinx-prompt',
     'sphinx_copybutton',
-    'myst_parser'
+    'myst_parser',
+    'breathe'
 ]
 
+# Setup the breathe extension
+# breathe_projects = {
+#     "xxxxxx": "@DOXYGEN_BUILD_DIR@/asap_xxxxxx/xml"
+# }
+# breathe_default_project = "xxxxxx"
+
 # Tell sphinx what the primary language being documented is.
 primary_domain = 'cpp'