"""Sphinx configuration.""" from __future__ import annotations import importlib.metadata from typing import Any project = "Heisskleber" author = "Felix Weiler-Detjen" copyright = "2023, Flucto GmbH" version = release = importlib.metadata.version("heisskleber") extensions = [ "myst_parser", "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.mathjax", "sphinx.ext.napoleon", "sphinx_autodoc_typehints", "sphinx_copybutton", ] autodoc_typehints = "description" # or 'signature' or 'both' autodoc_type_aliases = { "T": "heisskleber.core.T", "T_co": "heisskleber.core.T_co", "T_contra": "heisskleber.core.T_contra", } intersphinx_mapping = {"aiomqtt": ("https://aiomqtt.bo3hm.com/", None), "python": ("https://docs.python.org/3", None)} # If you're using typing.TypeVar in your code: nitpicky = True nitpick_ignore = [ ("py:class", "T"), ("py:class", "T_co"), ("py:class", "T_contra"), ("py:data", "typing.Any"), ("py:class", "_io.StringIO"), ("py:class", "_io.BytesIO"), ] source_suffix = [".rst", ".md"] exclude_patterns = [ "_build", "**.ipynb_checkpoints", "Thumbs.db", ".DS_Store", ".env", ".venv", ] html_theme = "furo" html_theme_options: dict[str, Any] = { "footer_icons": [ { "name": "GitHub", "url": "https://github.com/flucto-gmbh/heisskleber", "html": """ """, "class": "", }, ], "source_repository": "https://github.com/flucto-gmbh/heisskleber", "source_branch": "main", "source_directory": "docs/", } always_document_param_types = True