diff options
| author | Sayed Adel <seiko@imavr.com> | 2021-07-13 23:37:25 +0200 |
|---|---|---|
| committer | Sayed Adel <seiko@imavr.com> | 2021-08-30 21:01:46 +0200 |
| commit | a7d3a77121f0127b9402a78b1138d00dd4f973fc (patch) | |
| tree | 48f78a6a1b7eee64fdb3875d3a45f1e8b25b8fef /doc/source/conf.py | |
| parent | 7028aec45baf553b8d8a6aec12ac3167a9b3a962 (diff) | |
| download | numpy-a7d3a77121f0127b9402a78b1138d00dd4f973fc.tar.gz | |
DOC: Add support for documenting C/C++ via Doxygen & Breathe
Diffstat (limited to 'doc/source/conf.py')
| -rw-r--r-- | doc/source/conf.py | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 41b5cee25..835ad9064 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -84,6 +84,7 @@ extensions = [ 'IPython.sphinxext.ipython_console_highlighting', 'IPython.sphinxext.ipython_directive', 'sphinx.ext.mathjax', + 'breathe' ] # Add any paths that contain templates here, relative to this directory. @@ -477,3 +478,11 @@ class NumPyLexer(CLexer): inherit, ], } + + +# ----------------------------------------------------------------------------- +# Breathe & Doxygen +# ----------------------------------------------------------------------------- +breathe_projects = dict(numpy=os.path.join("..", "build", "doxygen", "xml")) +breathe_default_project = "numpy" +breathe_default_members = ("members", "undoc-members", "protected-members") |