diff options
author | Sayantika Banik <sayantikabanik122@gmail.com> | 2021-09-08 06:21:36 +0000 |
---|---|---|
committer | Sayantika Banik <sayantikabanik122@gmail.com> | 2021-09-08 06:21:36 +0000 |
commit | 879b3b4798975c7c0c49cef6ece3563c5f2daaeb (patch) | |
tree | e102f2222f1557d9b4f8b1a3e9484ca59b8ad954 /doc/source/conf.py | |
parent | 9680d760cdb08cc54c18657c77269853670f17e9 (diff) | |
parent | 17c3a6b414a3e642abeb116ff71e97f9b6f2aab5 (diff) | |
download | numpy-879b3b4798975c7c0c49cef6ece3563c5f2daaeb.tar.gz |
Merge branch 'main' of https://github.com/sayantikabanik/numpy
Diffstat (limited to 'doc/source/conf.py')
-rw-r--r-- | doc/source/conf.py | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 41b5cee25..d08f29e59 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -2,6 +2,7 @@ import os import re import sys +import importlib # Minimum version, enforced by sphinx needs_sphinx = '3.2.0' @@ -86,6 +87,16 @@ extensions = [ 'sphinx.ext.mathjax', ] +skippable_extensions = [ + ('breathe', 'skip generating C/C++ API from comment blocks.'), +] +for ext, warn in skippable_extensions: + ext_exist = importlib.util.find_spec(ext) is not None + if ext_exist: + extensions.append(ext) + else: + print(f"Unable to find Sphinx extension '{ext}', {warn}.") + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -477,3 +488,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") |