python-bro-code/docs/conf.py at main · PavanMudigonda/python-bro-code · 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
82
83
84
"""Sphinx configuration for Python Bro Code documentation."""

project = "Python Bro Code"
copyright = "2024, Pavan Mudigonda"
author = "Pavan Mudigonda"
release = "1.0.0"

extensions = [
    "myst_nb",
    "sphinx.ext.autodoc",
    "sphinx.ext.viewcode",
    "sphinx_copybutton",
    "sphinx_design",
]

myst_enable_extensions = [
    "colon_fence",
    "deflist",
    "fieldlist",
    "html_admonition",
    "html_image",
    "linkify",
    "replacements",
    "smartquotes",
    "strikethrough",
    "substitution",
    "tasklist",
]
myst_heading_anchors = 3

source_suffix = {
    ".rst": "restructuredtext",
    ".md": "myst-nb",
    ".ipynb": "myst-nb",
}

templates_path = ["_templates"]
exclude_patterns = [
    "_build",
    "Thumbs.db",
    ".DS_Store",
    "**/.ipynb_checkpoints",
    "**/__pycache__",
]

suppress_warnings = [
    "myst.header",
    "myst.xref_missing",
]

html_theme = "furo"
html_title = "Python Bro Code"
html_static_path = ["_static"]
html_css_files = ["custom.css"]
html_js_files = ["pyodide-runner.js"]

html_theme_options = {
    "light_css_variables": {
        "color-brand-primary": "#306998",
        "color-brand-content": "#306998",
    },
    "dark_css_variables": {
        "color-brand-primary": "#FFD43B",
        "color-brand-content": "#FFD43B",
    },
    "source_repository": "https://github.com/PavanMudigonda/python-bro-code",
    "source_branch": "main",
    "source_directory": "docs/",
}

# ---------------------------------------------------------------------------
# myst-nb: notebook execution settings
# ---------------------------------------------------------------------------
nb_execution_mode = "off"  # "off" renders existing outputs; switch to "auto" or
                           # "cache" to execute cells during the build.
nb_execution_timeout = 30
nb_execution_raise_on_error = False

# ---------------------------------------------------------------------------
# In-browser code execution (Pyodide via _static/pyodide-runner.js)
# ---------------------------------------------------------------------------
# - "Copy" button: provided by sphinx-copybutton on every code block.
# - "Run"  button: provided by pyodide-runner.js on every {code-cell} block.
#   Loads Pyodide (WebAssembly CPython) on first click — no server needed.