mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-03-31 14:24:16 +02:00
62 lines
1.7 KiB
Python
62 lines
1.7 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 = 'CyMaIS - Cyber Master Infrastructure Solution'
|
||
copyright = '2025, Kevin Veen-Birkenbach'
|
||
author = 'Kevin Veen-Birkenbach'
|
||
|
||
# -- General configuration ---------------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||
|
||
extensions = []
|
||
|
||
templates_path = ['_templates']
|
||
exclude_patterns = ['docs', 'venv', 'venv/**']
|
||
|
||
|
||
|
||
# -- Options for HTML output -------------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||
|
||
html_theme = 'alabaster'
|
||
html_static_path = ['_static']
|
||
html_sidebars = {
|
||
'**': [
|
||
'globaltoc.html', # globales Inhaltsverzeichnis
|
||
'relations.html', # Prev/Next Navigation
|
||
'searchbox.html', # Suchfeld
|
||
]
|
||
}
|
||
html_theme_options = {
|
||
'fixed_sidebar': True,
|
||
}
|
||
|
||
# Liste der Dateiendungen, die Sphinx verarbeiten soll:
|
||
source_suffix = {
|
||
'.rst': 'restructuredtext',
|
||
'.md': 'markdown',
|
||
}
|
||
|
||
# Erweiterungen hinzufügen – MyST-Parser aktivieren:
|
||
extensions = [
|
||
'myst_parser',
|
||
# ... andere Extensions
|
||
]
|
||
|
||
# Optional: Zusätzliche MyST-Konfigurationen
|
||
myst_enable_extensions = [
|
||
"colon_fence", # Für erweiterte Syntax wie ::: Hinweisboxen etc.
|
||
# weitere Erweiterungen nach Bedarf
|
||
]
|
||
|
||
myst_xref_ignore = [
|
||
r"\./roles/.*",
|
||
"../"
|
||
]
|
||
|