2023-05-19 10:43:52 -05:00
|
|
|
# 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
|
|
|
|
|
|
2025-10-31 14:32:55 -06:00
|
|
|
import datetime
|
|
|
|
|
year = datetime.date.today().year
|
|
|
|
|
|
2023-05-19 13:58:30 -05:00
|
|
|
project = "LibreQoE"
|
2025-10-31 14:32:55 -06:00
|
|
|
copyright = str(year) + ", LibreQoE, LLC"
|
|
|
|
|
author = "LibreQoE, LLC"
|
2023-05-19 10:43:52 -05:00
|
|
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
|
|
2026-02-25 19:40:43 -07:00
|
|
|
extensions = ["myst_parser", "sphinxcontrib.mermaid"]
|
2023-05-19 10:43:52 -05:00
|
|
|
|
2025-10-31 14:23:42 -06:00
|
|
|
myst_enable_extensions = [
|
|
|
|
|
'substitution'
|
|
|
|
|
]
|
|
|
|
|
|
2023-05-19 13:58:30 -05:00
|
|
|
templates_path = ["_templates"]
|
|
|
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
2023-05-19 10:43:52 -05:00
|
|
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
|
|
2023-05-19 13:58:30 -05:00
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
|
|
|
html_static_path = ["_static"]
|
2025-10-31 14:20:27 -06:00
|
|
|
|
2025-10-31 14:29:45 -06:00
|
|
|
def ultimateReplace(app, docname, source):
|
|
|
|
|
result = source[0]
|
|
|
|
|
for key in app.config.ultimate_replacements:
|
|
|
|
|
result = result.replace(key, app.config.ultimate_replacements[key])
|
|
|
|
|
source[0] = result
|
|
|
|
|
|
|
|
|
|
ultimate_replacements = {
|
2026-09-08 12:58:18 -06:00
|
|
|
"{deb_url_v1_5}" : "libreqos_2.2.202609081854-1_amd64.deb"
|
2025-10-31 14:23:42 -06:00
|
|
|
}
|
2025-10-31 14:29:45 -06:00
|
|
|
|
|
|
|
|
def setup(app):
|
|
|
|
|
app.add_config_value('ultimate_replacements', {}, True)
|
|
|
|
|
app.connect('source-read', ultimateReplace)
|