openapi-schema-validator/docs/conf.py at 208aa2463c6b0e783209c8645445522651413adf · python-openapi/openapi-schema-validator · 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
71
72
73
74
75
76
77
78
79
80
81
import re
import sys
from pathlib import Path

ROOT_DIR = Path(__file__).resolve().parents[1]
sys.path.insert(0, str(ROOT_DIR))


def _read_project_version() -> str:
    pyproject_path = ROOT_DIR / "pyproject.toml"
    pyproject_content = pyproject_path.read_text(encoding="utf-8")
    match = re.search(
        r"\[tool\.poetry\][\s\S]*?^version\s*=\s*\"([^\"]+)\"",
        pyproject_content,
        re.MULTILINE,
    )
    if match is None:
        return "unknown"
    return match.group(1)


project = "openapi-schema-validator"
copyright = "2023, Artur Maciag"
author = "Artur Maciag"

release = _read_project_version()

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.doctest",
    "sphinx.ext.intersphinx",
    "sphinx.ext.coverage",
    "sphinx.ext.viewcode",
    "sphinx_immaterial",
]

templates_path = ["_templates"]

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

html_theme = "sphinx_immaterial"

html_static_path = []

html_title = "openapi-schema-validator"

html_theme_options = {
    "analytics": {
        "provider": "google",
        "property": "G-11RDPBZ7EJ",
    },
    "repo_url": "https://github.com/python-openapi/openapi-schema-validator/",
    "repo_name": "openapi-schema-validator",
    "icon": {
        "repo": "fontawesome/brands/github-alt",
        "edit": "material/file-edit-outline",
    },
    "palette": [
        {
            "media": "(prefers-color-scheme: dark)",
            "scheme": "slate",
            "primary": "lime",
            "accent": "amber",
            "toggle": {
                "icon": "material/toggle-switch",
                "name": "Switch to light mode",
            },
        },
        {
            "media": "(prefers-color-scheme: light)",
            "scheme": "default",
            "primary": "lime",
            "accent": "amber",
            "toggle": {
                "icon": "material/toggle-switch-off-outline",
                "name": "Switch to dark mode",
            },
        },
    ],
    "globaltoc_collapse": False,
}