Attempt to incorporate doxygen generated docs for qrack

docs/conf.py

@@ -12,10 +12,16 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
 
+from run_doxygen import run_doxygen
+
+breathe_projects = {'qrack': '/tmp/qrack/doc/xml'}
+breathe_default_project = 'qrack'
+
+run_doxygen('qrack')
 
 # -- Project information -----------------------------------------------------
 
@@ -45,6 +51,7 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
+    'breathe',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -192,4 +199,4 @@
 # -- Options for todo extension ----------------------------------------------
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
+todo_include_todos = True

docs/index.rst

@@ -19,14 +19,14 @@ Hm!
 
 .. math::
    :nowrap:
+   :label: pmatrix2
 
    \begin{pmatrix}
    \alpha& \beta^{*}\\
    \gamma^{*}& \delta
    \end{pmatrix}
 
-   :label: pmatrix2
-   :caption: An example matrix.
+   :caption: A caption for pmatrix2
 
 That's a pretty nifty matrix at :eq:`pmatrix2`!
 
@@ -44,3 +44,5 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+.. doxygenindex::