dev-docs/conf.py at main · pyfenn/dev-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
import os
import sys


for _candidate in ['../fenn', 'fenn']:
    _p = os.path.abspath(_candidate)
    if os.path.exists(os.path.join(_p, 'fenn', '__init__.py')):
        sys.path.insert(0, _p)
        break

# -- Project information -----------------------------------------------------
project = "fenn"
copyright = "2026, pyfenn"
author = "pyfenn"
master_doc = "index"

# -- General configuration ---------------------------------------------------
extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.napoleon",
    "sphinx.ext.viewcode",
    "sphinx.ext.inheritance_diagram",
    "sphinx_copybutton",
    "sphinx_design",
    "myst_parser",
    "sphinxcontrib.mermaid",
]

# MyST Parser settings — enable all common extensions
myst_enable_extensions = [
    "colon_fence",
    "deflist",
    "tasklist",
]

# Tell Sphinx to look in src/ for the existing MkDocs markdown content
source_suffix = {
    ".rst": "restructuredtext",
    ".md": "markdown",
}

autodoc_typehints = "description"
autodoc_type_aliases = {}
autosummary_generate = True
autosummary_imported_members = False
inheritance_graph_attrs = {"rankdir": "TB"}

html_css_files = ["custom.css"]
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# -- Options for HTML output -------------------------------------------------
html_theme = "furo"
html_title = "Fenn Documentation"
html_logo = "_static/logo.png"
html_favicon = "_static/icon.svg"
html_theme_options = {
    "source_repository": "https://github.com/pyfenn/fenn",
    "source_branch": "main",
    "source_directory": "docs/",
    "light_css_variables": {
        "color-brand-primary": "#00A86B",
        "color-brand-content": "#00A86B",
    },
    "dark_css_variables": {
        "color-brand-primary": "#00C887",
        "color-brand-content": "#00C887",
    },
}