Konfiguration

Die Datei conf.py sammelt alle Standardeinstellungen, die angepasst und ergänzt werden können.

# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'Sphinx'
copyright = '2022, Peter Koppatz'
author = 'Peter Koppatz'
html_title= " "
html_logo = "_static/sphinx-silhouette.svg"

# The full version, including alpha/beta/rc tags
release = '1'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.graphviz',
    'sphinx_inline_tabs',
    'sphinxcontrib.plantuml',
    'sphinx.ext.todo',
    'sphinx_git',
   ]

graphviz_output_format = 'svg'
todo_include_todos = True

#plantuml = 'java -jar ../../../tools/uml/plantuml/plantum.jar'[:-2]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'de'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'furo'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_theme_options = {

    "light_css_variables": {
        "color-sidebar-background": '#f7eaac', # "#cfe0e8",
        "color-background-secondary": '#fdffcd', 
    },
}

html_css_files = [
    'custom.css',
]

templates_path = ["_templates"]
html_static_path = ['_static']