50 lines
1.6 KiB
Python
50 lines
1.6 KiB
Python
|
# Configuration file for the Sphinx documentation builder.
|
||
|
|
#
|
||
|
|
# For the full list of built-in configuration values, see the documentation:
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||
|
|
|
||
|
|
# -- Project information -----------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||
|
|
|
||
|
|
project = 'cpp-example'
|
||
|
|
copyright = '2024, Alexandre Foucher'
|
||
|
|
author = 'Alexandre Foucher'
|
||
|
|
release = '1.0'
|
||
|
|
|
||
|
|
# -- General configuration ---------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||
|
|
|
||
|
|
extensions = [
|
||
|
|
'breathe',
|
||
|
|
'exhale'
|
||
|
|
]
|
||
|
|
|
||
|
|
breathe_projects = {"My Project": "../build/_doxygen/xml"}
|
||
|
|
breathe_default_project = "My Project"
|
||
|
|
|
||
|
|
exhale_args = {
|
||
|
|
# These arguments are required
|
||
|
|
"containmentFolder": "./api",
|
||
|
|
"rootFileName": "library_root.rst",
|
||
|
|
"doxygenStripFromPath": "..",
|
||
|
|
# Heavily encouraged optional argument (see docs)
|
||
|
|
"rootFileTitle": "Library API",
|
||
|
|
# Suggested optional arguments
|
||
|
|
"createTreeView": True,
|
||
|
|
# TIP: if using the sphinx-bootstrap-theme, you need
|
||
|
|
# "treeViewIsBootstrap": True,
|
||
|
|
"exhaleExecutesDoxygen": True,
|
||
|
|
"exhaleDoxygenStdin": "INPUT = ../../include"
|
||
|
|
}
|
||
|
|
|
||
|
|
templates_path = ['_templates']
|
||
|
|
exclude_patterns = []
|
||
|
|
|
||
|
|
language = 'fr'
|
||
|
|
|
||
|
|
# -- Options for HTML output -------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||
|
|
|
||
|
|
html_theme = 'shibuya'
|
||
|
|
html_static_path = ['_static']
|