# 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 import os import sys from datetime import datetime from typing import List, Dict, Any import libbot sys.path.insert(0, os.path.abspath("..")) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project: str = "LibBotUniversal" author: str = libbot.__author__ version: str = libbot.__version__ release: str = version copyright: str = f"{datetime.now().year} {author}" html_title: str = f"{project} v{version} Documentation" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions: List[str] = [ "sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.viewcode", "sphinx.ext.viewcode", "sphinx.ext.napoleon", "sphinx_copybutton", ] templates_path: List[str] = ["_templates"] exclude_patterns: List[str] = ["_build", "Thumbs.db", ".DS_Store"] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme: str = "furo" html_static_path: List[str] = ["_static"] html_theme_options: Dict[str, Any] = { "source_repository": "https://git.end-play.xyz/profitroll/LibBotUniversal", "source_branch": "main", "source_directory": "docs/", "light_css_variables": { "font-stack": "'Outfit', sans-serif", }, } resource_links: Dict[str, Any] = { "issues": "https://git.end-play.xyz/profitroll/LibBotUniversal/issues", "examples": "https://git.end-play.xyz/profitroll/LibBotUniversal/tree/main/examples", }