CPS-IT/project-builder

# 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 = "Project Builder"
copyright = "since 2022 by coding. powerful. systems. CPS GmbH"
author = "Elias Häußler, Martin Adler"
release = "2.12.0"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    "myst_parser",
    "sphinx_copybutton",
    "sphinx_design",
    "sphinxext.opengraph"
]
myst_enable_extensions = [
    "colon_fence",
    "substitution"
]
myst_heading_anchors = 3

exclude_patterns = ["_build/**"]
templates_path = ["_templates"]
html_static_path = ["_static"]
html_css_files = [
    "css/sidebar.css"
]

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "furo"
html_theme_options = {
    "footer_icons": [
        {
            "name": "GitHub",
            "url": "https://github.com/CPS-IT/project-builder",
            "html": """
                <svg stroke="currentColor" fill="currentColor" stroke-width="0" role="img" viewBox="0 0 24 24" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><title></title><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"></path></svg>
            """
        }
    ],
    "source_repository": "https://github.com/CPS-IT/project-builder",
    "source_branch": "main",
    "source_directory": "docs/"
}

# -- OpenGraph configuration -------------------------------------------------
# https://github.com/wpilibsuite/sphinxext-opengraph#options

ogp_site_url = "https://project-builder.cps-it.de/"
ogp_image = "_static/img/header.png"
ogp_enable_meta_description = False

## -- Syntax Highlighting ----------------------------------------------------

from sphinx.highlighting import lexers
from pygments.lexers.web import PhpLexer

lexers["php"] = PhpLexer(startinline=True)