Update documentation system with doxygen/breathe/sphinx
This commit is contained in:
1 parent
fad8b68e01
commit
72bd29ddbc
9 files changed
+231
-2896
No files matched your search
@@ -0,0 +1,34 @@
|
||||
# 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 = 'RP2040-Decoder'
|
||||
copyright = '2024, Gabriel Koppenstein'
|
||||
author = 'Gabriel Koppenstein'
|
||||
release = '0.3, 1.0'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
extensions = ['myst_parser', 'breathe',]
|
||||
|
||||
templates_path = ['_templates']
|
||||
exclude_patterns = []
|
||||
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Breathe Configuration
|
||||
breathe_projects = {
|
||||
"RP2040-Decoder": "../../doxygen/build/xml"
|
||||
}
|
||||
breathe_default_project = "RP2040-Decoder"
|
||||
Reference in new issue
Block a user