From a7d3a77121f0127b9402a78b1138d00dd4f973fc Mon Sep 17 00:00:00 2001 From: Sayed Adel Date: Tue, 13 Jul 2021 23:37:25 +0200 Subject: DOC: Add support for documenting C/C++ via Doxygen & Breathe --- doc/source/conf.py | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'doc/source/conf.py') 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") -- cgit v1.2.1