executable-tutorials/conf.py at main · scientific-python/executable-tutorials · 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
# -- Project information -----------------------------------------------------

project = 'Scientific Python Executable Tutorials'
copyright = '2025, Scientific Python developers'
author = 'Scientific Python developers'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.

extensions = [
    "myst_nb",
    "sphinx_copybutton",
    "sphinx_design",
    "sphinx_thebe",
]

myst_enable_extensions = [
    'dollarmath',
]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
    '_build',
    'notes',
    '.pixi',
    '.tox',
    '.tmp',
    '.pytest_cache',
    'README.md'
]

# MyST-NB configuration
nb_merge_streams = True
nb_execution_mode = "cache"

# We do ignore the JB2 landing page when rendering with JB1
exclude_patterns += ['index_jb2.md']


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_book_theme'
html_title = 'Executable Tutorials'
html_theme_options = {
    "repository_url": "https://github.com/scientific-python/executable-tutorials",
    "repository_branch": "main",
    "use_repository_button": True,
    "use_issues_button": True,
    "use_edit_page_button": True,
    "launch_buttons": {
        "binderhub_url": "https://mybinder.org",
        "thebe": True,
    },
}