mri-toolkit/conf.py at main · scientificcomputing/mri-toolkit · 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
###############################################################################
# Auto-generated by `jupyter-book config`
# If you wish to continue using _config.yml, make edits to that file and
# re-generate this one.
###############################################################################
author = "Simula Research Laboratory"
bibtex_bibfiles = ["docs/refs.bib"]
codeautolink_concat_default = True
comments_config = {"hypothesis": False, "utterances": False}
copyright = "2026"
exclude_patterns = [
    "**.ipynb_checkpoints",
    ".DS_Store",
    ".github/*",
    ".pytest_cache/*",
    ".tox/*",
    "Thumbs.db",
    "_build",
    "third_party/*",
    "jupyter_execute/",
    "**.jupyter_cache",
    "venv/*",
    "test-*htmlcov/*",
    "new-test-data/*",
    "mritk-test-data/*",
]
extensions = [
    "sphinx_togglebutton",
    "sphinx_copybutton",
    "myst_nb",
    "sphinx_comments",
    "sphinx_external_toc",
    "sphinx.ext.intersphinx",
    "sphinx_design",
    "sphinx_book_theme",
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    "sphinx.ext.viewcode",
    "sphinxcontrib.bibtex",
    "sphinx_codeautolink",
    "sphinx_multitoc_numbering",
    "sphinxcontrib.mermaid",
]
myst_enable_extensions = [
    "amsmath",
    "attrs_inline",
    "colon_fence",
    "deflist",
    "dollarmath",
    "fieldlist",
    "html_admonition",
    "html_image",
    "linkify",
    "replacements",
    "smartquotes",
    "strikethrough",
    "substitution",
    "tasklist",
]
external_toc_exclude_missing = True
external_toc_path = "_toc.yml"
html_baseurl = ""
html_favicon = ""
html_last_updated_fmt = "%b %d, %Y"
html_logo = "docs/logo.png"
html_sourcelink_suffix = ""
# html_static_path = ["_static"]
html_theme = "sphinx_book_theme"
html_theme_options = {
    "search_bar_text": "Search this book...",
    "launch_buttons": {
        "notebook_interface": "classic",
        "binderhub_url": "",
        "jupyterhub_url": "",
        "thebe": False,
        "colab_url": "",
        "deepnote_url": "",
    },
    "path_to_docs": "",
    "repository_url": "https://github.com/scientificcomputing/mri-toolkit",
    "repository_branch": "main",
    "extra_footer": "",
    "home_page_in_toc": True,
    "announcement": "",
    "analytics": {
        "google_analytics_id": "",
        "plausible_analytics_domain": "",
        "plausible_analytics_url": "https://plausible.io/js/script.js",
    },
    "use_repository_button": True,
    "use_edit_page_button": False,
    "use_issues_button": True,
}
html_title = "mri-toolkit"
intersphinx_mapping = {
    "numpy": ["https://numpy.org/doc/stable/", None],
    "matplotlib": ["https://matplotlib.org/stable/", None],
    "packaging": ["https://packaging.pypa.io/en/stable/", None],
}
latex_engine = "pdflatex"
myst_url_schemes = ["mailto", "http", "https"]
nb_custom_formats = {".py": ["jupytext.reads", {"fmt": "py"}]}
nb_execution_allow_errors = False
nb_execution_cache_path = ""
nb_execution_excludepatterns: list[str] = []
nb_execution_in_temp = False
nb_execution_mode = "cache"
nb_execution_show_tb = True
nb_execution_timeout = 3000
nb_output_stderr = "show"
numfig = True
pygments_style = "sphinx"
suppress_warnings = ["mystnb.unknown_mime_type", "bibtex.duplicate_citation"]
use_jupyterbook_latex = True
use_multitoc_numbering = True