Open-BeatBox.github.io/docs/source/conf.py at main · Open-BeatBox/Open-BeatBox.github.io · 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
from __future__ import annotations

from pathlib import Path
import sys


sys.path.insert(0, str(Path(__file__).parent / "_ext"))

project = "BEATBox Documentation"
author = "NERB team"
copyright = "2026, NERB team"
release = "draft"

extensions = [
    "assembly_videos",
    "myst_parser",
    "sphinx_design",
]

templates_path = ["_templates"]
exclude_patterns = [
    "_build",
    "Thumbs.db",
    ".DS_Store",
    "build/assembly-tutorials/README.md",
    "build/assembly-tutorials/modules/README.md",
]

source_suffix = {
    ".rst": "restructuredtext",
    ".md": "markdown",
}

html_theme = "furo"
html_title = "BEATBox Documentation"
html_static_path = ["_static"]
html_css_files = ["custom.css"]
html_favicon = "../../site/public/favicon.png"
html_logo = "../../site/public/images/beatbox-logo.png"

html_theme_options = {
    "light_css_variables": {
        "color-brand-primary": "#0891b2",
        "color-brand-content": "#0e7490",
    },
    "dark_css_variables": {
        "color-brand-primary": "#67e8f9",
        "color-brand-content": "#67e8f9",
    },
    "source_repository": "https://github.com/Open-BeatBox/Open-BeatBox.github.io/",
    "source_branch": "main",
    "source_directory": "docs/source/",
}

myst_enable_extensions = [
    "colon_fence",
    "deflist",
    "linkify",
    "substitution",
    "tasklist",
]

root_doc = "index"

nitpicky = False

html_context = {
    "display_github": True,
    "github_user": "Open-BeatBox",
    "github_repo": "Open-BeatBox.github.io",
    "github_version": "main",
    "conf_py_path": "/docs/source/",
}

_static = Path(__file__).parent / "_static"
_static.mkdir(exist_ok=True)