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# This should point to the directory where Doxygen outputs the XML files.
19breathe_projects = {
20    "myproject": "./_build/xml/"
21}
22breathe_default_project = "myproject"
23
24# Add any paths that contain templates here, relative to this directory.
25templates_path = ['_templates']
26
27# List of patterns, relative to source directory, that match files and
28# directories to ignore when looking for source files.
29# This pattern also affects html_static_path and html_extra_path.
30exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
31
32# -- Options for HTML output -------------------------------------------------
33
34# The theme to use for HTML and HTML Help pages.  See the documentation for
35# a list of builtin themes.
36#
37html_theme = 'alabaster'