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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
# -- Project information -----------------------------------------------------
import os
from pathlib import Path
from datetime import datetime
project = "Sphinx Book Theme"
copyright = str(datetime.now().year)
author = "the Executable Book Project"
# language = "fr" # For testing language translations
master_doc = "index"
# -- 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",
"numpydoc",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx_copybutton",
"sphinx_design",
"sphinx_examples",
"sphinx_tabs.tabs",
"sphinx_thebe",
"sphinxcontrib.bibtex",
"sphinxext.opengraph",
# For the kitchen sink
"sphinx.ext.todo",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# 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", "Thumbs.db", ".DS_Store"]
intersphinx_mapping = {
"python": ("/usr/share/doc/python3-doc/html", None),
"sphinx": ("/usr/share/doc/sphinx-doc/html", None),
"pst": ("/usr/share/doc/python-pydata-sphinx-theme-doc/html", None),
}
nitpick_ignore = [
("py:class", "docutils.nodes.document"),
("py:class", "docutils.parsers.rst.directives.body.Sidebar"),
]
suppress_warnings = ["myst.domains", "ref.ref"]
numfig = True
myst_enable_extensions = [
"dollarmath",
"amsmath",
"deflist",
# "html_admonition",
# "html_image",
"colon_fence",
# "smartquotes",
# "replacements",
# "linkify",
# "substitution",
]
# -- 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_logo = "_static/logo-wide.svg"
html_title = "Sphinx Book Theme"
html_copy_source = True
html_favicon = "_static/logo-square.svg"
html_last_updated_fmt = ""
html_sidebars = {
"reference/blog/*": [
"navbar-logo.html",
"search-field.html",
"sbt-sidebar-nav.html",
]
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_css_files = ["custom.css"]
nb_execution_mode = "cache"
thebe_config = {
"repository_url": "https://github.com/binder-examples/jupyter-stacks-datascience",
"repository_branch": "master",
}
html_theme_options = {
"path_to_docs": "docs",
"repository_url": "https://github.com/executablebooks/sphinx-book-theme",
"repository_branch": "master",
"launch_buttons": {
"binderhub_url": "https://mybinder.org",
"colab_url": "https://colab.research.google.com/",
"deepnote_url": "https://deepnote.com/",
"notebook_interface": "jupyterlab",
"thebe": True,
# "jupyterhub_url": "https://datahub.berkeley.edu", # For testing
},
"use_edit_page_button": True,
"use_source_button": True,
"use_issues_button": True,
# "use_repository_button": True,
"use_download_button": True,
"use_sidenotes": True,
"show_toc_level": 2,
"announcement": (
"⚠️The latest release refactored our HTML, "
"so double-check your custom CSS rules!⚠️"
),
"logo": {
"image_dark": "_static/logo-wide-dark.svg",
# "text": html_title, # Uncomment to try text with logo
},
"icon_links": [
{
"name": "Executable Books",
"url": "https://executablebooks.org/",
"icon": "_static/ebp-logo.png",
"type": "local",
},
{
"name": "GitHub",
"url": "https://github.com/executablebooks/sphinx-book-theme",
"icon": "fa-brands fa-github",
},
{
"name": "PyPI",
"url": "https://pypi.org/project/sphinx-book-theme/",
"icon": "fa-brands fa-python",
},
],
# For testing
# "use_fullscreen_button": False,
# "home_page_in_toc": True,
# "extra_footer": "<a href='https://google.com'>Test</a>", # DEPRECATED KEY
# "show_navbar_depth": 2,
# Testing layout areas
# "navbar_start": ["test.html"],
# "navbar_center": ["test.html"],
# "navbar_end": ["test.html"],
# "navbar_persistent": ["test.html"],
# "footer_start": ["test.html"],
# "footer_end": ["test.html"]
}
# sphinxext.opengraph
ogp_social_cards = {
"image": "_static/logo-square.png",
}
# -- sphinx-copybutton config -------------------------------------
copybutton_exclude = ".linenos, .gp"
# -- ABlog config -------------------------------------------------
blog_path = "reference/blog"
blog_post_pattern = "reference/blog/*.md"
blog_baseurl = "https://sphinx-book-theme.readthedocs.io"
fontawesome_included = True
post_auto_image = 1
post_auto_excerpt = 2
nb_execution_show_tb = "READTHEDOCS" in os.environ
bibtex_bibfiles = ["references.bib"]
# To test that style looks good with common bibtex config
bibtex_reference_style = "author_year"
bibtex_default_style = "plain"
numpydoc_show_class_members = False # for automodule:: urllib.parse stub file issue
linkcheck_ignore = [
"http://someurl/release", # This is a fake link
"https://doi.org", # These don't resolve properly and cause SSL issues
]
linkcheck_exclude_documents = ["changelog"]
# -- Download latest theme elements page from PyData -----------------------------
path_pydata_content = "/usr/share/doc/python-pydata-sphinx-theme-doc/html/_sources/user_guide/theme-elements.md" # noqa
path_content_file = Path(__file__).parent / "content/pydata-content-blocks.md"
if not path_content_file.exists():
with open(path_pydata_content) as resp:
# Read in the content page file, then update the title and add context
content = resp.read().split("\n")
ix_title = content.index("# Theme-specific elements")
content[ix_title] = "# PyData Theme Elements"
content.insert(
ix_title + 1,
"\nThis is a collection of content blocks with special support from this theme's parent theme, [the PyData Sphinx Theme](https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/theme-elements.html)\n", # noqa
) # noqa
content = "\n".join(content)
# Replace a relative link in the pydata docs w/ the respective one here
content = content.replace("../examples/pydata.ipynb", "notebooks.md")
# Write to disk in a location that will be ignored by git
path_content_file.write_text(content)
mathjax_path = "file:///usr/share/nodejs/mathjax-full/es5/tex-mml-chtml.js"
|
