conf.py

from sphinx.application import Sphinx

# 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 = "Garden Linux Python Library"
copyright = "2024, Garden Linux Maintainers"
author = "Garden Linux Maintainers"

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

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.coverage",
    "sphinx_rtd_theme",
    "sphinx.ext.napoleon",
    "sphinx_click",
    "sphinxcontrib.autoprogram",
    "sphinx_markdown_builder",
]

# Markdown builder configuration (GitHub-Flavored Markdown for VitePress)
# We can enable this after https://github.com/liran-funaro/sphinx-markdown-builder/pull/53 is merged
# markdown_flavor = "github"
markdown_anchor_sections = True
markdown_anchor_signatures = True

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
autodoc_mock_imports = ["networkx"]


# -- 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"]

# Logo configuration
html_logo = "_static/gardenlinux-logo.svg"

html_theme_options = {
    "logo_only": False,
    "prev_next_buttons_location": "bottom",
    "style_external_links": True,
    "vcs_pageview_mode": "",
    "style_nav_header_background": "#027154",  # Primary green
    "collapse_navigation": True,
    "sticky_navigation": True,
    "navigation_depth": 4,
    "includehidden": True,
    "titles_only": False,
}


# Add custom CSS
def setup(app: Sphinx) -> None:
    app.add_css_file("custom.css")