Update sphinx docs; use exhale and breathe.

This commit is contained in:
2019-08-07 01:57:26 +00:00
parent 48729670c1
commit 7a932f422a
10 changed files with 209 additions and 10 deletions

View File

@@ -31,7 +31,8 @@ release = '0.0.1'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'breathe',
'breathe',
'exhale',
]
# Add any paths that contain templates here, relative to this directory.
@@ -48,7 +49,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
# 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,
@@ -58,3 +59,23 @@ html_static_path = ['_static']
# -- Options for breathe output ----------------------------------------------
breathe_projects = {'wrmath': '../xml/'}
breathe_default_project = 'wrmath'
# -- Options for exhale output -----------------------------------------------
exhale_args = {
# These arguments are required
"containmentFolder": "./api",
"rootFileName": "wrmath.rst",
"rootFileTitle": "libwrmath API",
"doxygenStripFromPath": "..",
# Suggested optional arguments
"createTreeView": True,
#"exhaleExecutesDoxygen": True,
#"exhaleDoxygenStdin": "INPUT = ../include"
}
# Tell sphinx what the primary language being documented is.
primary_domain = 'cpp'
# Tell sphinx what the pygments highlight language should be.
highlight_language = 'cpp'