sphinx_conf_with_breathe_doxygen_xml_integration.py

1# Configuration file for the Sphinx documentation builder.
2# This file only contains a selection of the most common options.
3
4# -- Project information -----------------------------------------------------
5
6project = 'My Project'
7copyright = '2024, My Name'
8author = 'My Name'
9
10# -- General configuration ---------------------------------------------------
11
12# Add 'breathe' to the extensions list
13extensions = [
14    'breathe',
15]
16
17# -- Breathe configuration ---------------------------------------------------
18
19# Provide a dictionary of project names and the path to the Doxygen XML output
20breathe_projects = {
21    "myproject": "./doxygen/xml/",
22}
23
24# Set the default project
25breathe_default_project = "myproject"
26
27# Add any paths that contain templates here, relative to this directory.
28templates_path = ['_templates']
29
30# List of patterns, relative to source directory, that match files and
31# directories to ignore when looking for source files.
32exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
33
34# -- Options for HTML output -------------------------------------------------
35
36# The theme to use for HTML and HTML Help pages.
37html_theme = 'alabaster'