85 lines
2.7 KiB
Python
85 lines
2.7 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# http://www.sphinx-doc.org/en/master/config
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'wrmath'
|
|
copyright = '2019, K. Isom'
|
|
author = 'K. Isom'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = '0.0.1'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'breathe',
|
|
'exhale',
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
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,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
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 ../../wrmath
|
|
USE_XML = YES
|
|
"""
|
|
}
|
|
|
|
# Tell sphinx what the primary language being documented is.
|
|
primary_domain = 'cpp'
|
|
|
|
# Tell sphinx what the pygments highlight language should be.
|
|
highlight_language = 'cpp'
|