aboutsummaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
authorToni <matzeton@googlemail.com>2022-05-29 13:44:52 +0200
committerGitHub <noreply@github.com>2022-05-29 13:44:52 +0200
commit6b7b23b01d50468263b707abdf79146f1d4c821f (patch)
tree7d63d44c0e00ac19a1df787866855609b09aae58 /doc/conf.py
parent33f9729ee4881f92afad662008a3d378aee2887d (diff)
Use Doxygen to generate the API documentation. (#1558)
* Integrated Doxygen documentation into Sphinx Signed-off-by: lns <matzeton@googlemail.com>
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py19
1 files changed, 16 insertions, 3 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 2337a37f0..9650652f2 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -21,7 +21,8 @@ sys.path.append( "breathe/" )
# ones.
extensions = [
'sphinx.ext.intersphinx',
- 'breathe'
+ 'breathe',
+ 'exhale'
]
# Workaround for platforms where swaggerdoc is not available
@@ -31,6 +32,18 @@ if not os.environ.get("PYTHON_SKIP_SWAGGERDOC"):
breathe_projects = { "apidoc" : "doxygen/xml/" }
breathe_default_project = "apidoc"
+exhale_args = {
+ "containmentFolder": "./api",
+ "rootFileName": "library_root.rst",
+ "rootFileTitle": "Library API",
+ "doxygenStripFromPath": ".",
+ "createTreeView": True,
+ # "treeViewIsBootstrap": True,
+}
+
+primary_domain = 'c'
+highlight_language = 'c'
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -139,7 +152,7 @@ html_logo = "img/logo.png"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
@@ -288,4 +301,4 @@ texinfo_documents = [
intersphinx_mapping = {'https://docs.python.org/': None}
def setup(app):
- app.add_stylesheet('css/ntop.css')
+ app.add_css_file('css/ntop.css')