1# -*- coding: utf-8 -*-
2
3# Default settings
4project = 'Test Builds'
5extensions = [
6 'sphinx_autorun',
7]
8
9latex_engine = 'xelatex' # allow us to build Unicode chars
10
11
12# Include all your settings here
13html_theme = 'sphinx_rtd_theme'
14
15
16
17
18###########################################################################
19# auto-created readthedocs.org specific configuration #
20###########################################################################
21
22
23#
24# The following code was added during an automated build on readthedocs.org
25# It is auto created and injected for every build. The result is based on the
26# conf.py.tmpl file found in the readthedocs.org codebase:
27# https://github.com/rtfd/readthedocs.org/blob/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
28#
29# Note: this file shouldn't rely on extra dependencies.
30
31import importlib
32import sys
33import os.path
34
35# Borrowed from six.
36PY3 = sys.version_info[0] == 3
37string_types = str if PY3 else basestring
38
39from sphinx import version_info
40
41# Get suffix for proper linking to GitHub
42# This is deprecated in Sphinx 1.3+,
43# as each page can have its own suffix
44if globals().get('source_suffix', False):
45 if isinstance(source_suffix, string_types):
46 SUFFIX = source_suffix
47 elif isinstance(source_suffix, (list, tuple)):
48 # Sphinx >= 1.3 supports list/tuple to define multiple suffixes
49 SUFFIX = source_suffix[0]
50 elif isinstance(source_suffix, dict):
51 # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes
52 SUFFIX = list(source_suffix.keys())[0] # make a ``list()`` for py2/py3 compatibility
53 else:
54 # default to .rst
55 SUFFIX = '.rst'
56else:
57 SUFFIX = '.rst'
58
59# Add RTD Static Path. Add to the end because it overwrites previous files.
60if not 'html_static_path' in globals():
61 html_static_path = []
62if os.path.exists('_static'):
63 html_static_path.append('_static')
64
65# Add RTD Theme only if they aren't overriding it already
66using_rtd_theme = (
67 (
68 'html_theme' in globals() and
69 html_theme in ['default'] and
70 # Allow people to bail with a hack of having an html_style
71 'html_style' not in globals()
72 ) or 'html_theme' not in globals()
73)
74if using_rtd_theme:
75 theme = importlib.import_module('sphinx_rtd_theme')
76 html_theme = 'sphinx_rtd_theme'
77 html_style = None
78 html_theme_options = {}
79 if 'html_theme_path' in globals():
80 html_theme_path.append(theme.get_html_theme_path())
81 else:
82 html_theme_path = [theme.get_html_theme_path()]
83
84if globals().get('websupport2_base_url', False):
85 websupport2_base_url = 'https://readthedocs.org/websupport'
86 websupport2_static_url = 'https://assets.readthedocs.org/static/'
87
88
89#Add project information to the template context.
90context = {
91 'using_theme': using_rtd_theme,
92 'html_theme': html_theme,
93 'current_version': "wormhole",
94 'version_slug': "wormhole",
95 'MEDIA_URL': "https://media.readthedocs.org/",
96 'STATIC_URL': "https://assets.readthedocs.org/static/",
97 'PRODUCTION_DOMAIN': "readthedocs.org",
98 'proxied_static_path': "/_/static/",
99 'versions': [
100 ("latest", "/en/latest/"),
101 ("4.0", "/en/4.0/"),
102 ("2.0", "/en/2.0/"),
103 ("yaml-v2", "/en/yaml-v2/"),
104 ("wormhole", "/en/wormhole/"),
105 ("use-requirements-from-submodule", "/en/use-requirements-from-submodule/"),
106 ("use-py2", "/en/use-py2/"),
107 ("use-image-5.0rc1", "/en/use-image-5.0rc1/"),
108 ("use-apt", "/en/use-apt/"),
109 ("unicode-filename", "/en/unicode-filename/"),
110 ("d--branch", "/en/d--branch/"),
111 ("ubuntu-22.04", "/en/ubuntu-22.04/"),
112 ("typlog-theme", "/en/typlog-theme/"),
113 ("timetestlarge", "/en/timetestlarge/"),
114 ("timetest", "/en/timetest/"),
115 ("timeout", "/en/timeout/"),
116 ("throw-exception", "/en/throw-exception/"),
117 ("test-rebased-commit", "/en/test-rebased-commit/"),
118 ("test-py-37", "/en/test-py-37/"),
119 ("test-pr-builder", "/en/test-pr-builder/"),
120 ("test-paths-with-spaces", "/en/test-paths-with-spaces/"),
121 ("testing-image", "/en/testing-image/"),
122 ("testing-activate-version", "/en/testing-activate-version/"),
123 ("test-code-injection-2", "/en/test-code-injection-2/"),
124 ("test-code-injection", "/en/test-code-injection/"),
125 ("test-agj-foo", "/en/test-agj-foo/"),
126 ("tag-v2", "/en/tag-v2/"),
127 ("tag-v1", "/en/tag-v1/"),
128 ("sudo-commands", "/en/sudo-commands/"),
129 ("submodule-not-found", "/en/submodule-not-found/"),
130 ("submodule-https-scheme", "/en/submodule-https-scheme/"),
131 ("submodule-git-scheme", "/en/submodule-git-scheme/"),
132 ("sphinx-tabs", "/en/sphinx-tabs/"),
133 ("sphinx-mkdocstrings", "/en/sphinx-mkdocstrings/"),
134 ("sphinx-latest", "/en/sphinx-latest/"),
135 ("sphinx-fork", "/en/sphinx-fork/"),
136 ("sphinx.ext.duration", "/en/sphinx.ext.duration/"),
137 ("sphinx-es-suggest", "/en/sphinx-es-suggest/"),
138 ("sphinx-docs-zundler", "/en/sphinx-docs-zundler/"),
139 ("sphinx5.x-default-confpy", "/en/sphinx5.x-default-confpy/"),
140 ("sphinx-5.x", "/en/sphinx-5.x/"),
141 ("sphinx-3.x", "/en/sphinx-3.x/"),
142 ("sphinx2", "/en/sphinx2/"),
143 ("sphinx-1.8", "/en/sphinx-1.8/"),
144 ("sphinx-1.7", "/en/sphinx-1.7/"),
145 ("sphinx-1.6", "/en/sphinx-1.6/"),
146 ("skip-build-command", "/en/skip-build-command/"),
147 ("shot-scraper", "/en/shot-scraper/"),
148 ("search-with-old-sphinx-and-theme", "/en/search-with-old-sphinx-and-theme/"),
149 ("rust", "/en/rust/"),
150 ("run-rust", "/en/run-rust/"),
151 ("rtd-sphinx-ext", "/en/rtd-sphinx-ext/"),
152 ("robots-txt", "/en/robots-txt/"),
153 ("requirements-not-found", "/en/requirements-not-found/"),
154 ("regular-404-page", "/en/regular-404-page/"),
155 ("recommonmark", "/en/recommonmark/"),
156 ("pypy3.5", "/en/pypy3.5/"),
157 ("pygments-custom-lexer-apex", "/en/pygments-custom-lexer-apex/"),
158 ("py3.9", "/en/py3.9/"),
159 ("py3.8", "/en/py3.8/"),
160 ("py3.5", "/en/py3.5/"),
161 ("py3.11", "/en/py3.11/"),
162 ("py3.10", "/en/py3.10/"),
163 ("pr-visual-diff", "/en/pr-visual-diff/"),
164 ("poetry-asdf", "/en/poetry-asdf/"),
165 ("poetry", "/en/poetry/"),
166 ("pelican", "/en/pelican/"),
167 ("path-with-plus", "/en/path-with-plus/"),
168 ("no-conf-py", "/en/no-conf-py/"),
169 ("no-config-file", "/en/no-config-file/"),
170 ("nbsphinx-3d-plot", "/en/nbsphinx-3d-plot/"),
171 ("multiple-source-suffix", "/en/multiple-source-suffix/"),
172 ("meta-tags", "/en/meta-tags/"),
173 ("mamba", "/en/mamba/"),
174 ("main", "/en/main/"),
175 ("jsdoc-autoapi", "/en/jsdoc-autoapi/"),
176 ("jsdoc", "/en/jsdoc/"),
177 ("japanese-pdf", "/en/japanese-pdf/"),
178 ("invalid-submodules", "/en/invalid-submodules/"),
179 ("install-setuptools", "/en/install-setuptools/"),
180 ("install-pytorch", "/en/install-pytorch/"),
181 ("install-aiohttp", "/en/install-aiohttp/"),
182 ("image", "/en/image/"),
183 ("huge-build-output", "/en/huge-build-output/"),
184 ("htmldir", "/en/htmldir/"),
185 ("hide-me", "/en/hide-me/"),
186 ("git-submodules-invalid", "/en/git-submodules-invalid/"),
187 ("git-submodules", "/en/git-submodules/"),
188 ("git-lfs-build-jobs", "/en/git-lfs-build-jobs/"),
189 ("git-lfs", "/en/git-lfs/"),
190 ("forced-push-tag", "/en/forced-push-tag/"),
191 ("file-with-apostrophe", "/en/file-with-apostrophe/"),
192 ("expose-env-pip-error", "/en/expose-env-pip-error/"),
193 ("explicit-flyout-placement", "/en/explicit-flyout-placement/"),
194 ("environment-variables", "/en/environment-variables/"),
195 ("docsify-ads", "/en/docsify-ads/"),
196 ("docsify", "/en/docsify/"),
197 ("datetime", "/en/datetime/"),
198 ("d2lbook", "/en/d2lbook/"),
199 ("custom-404-page", "/en/custom-404-page/"),
200 ("conda-satisfied-skip-solve", "/en/conda-satisfied-skip-solve/"),
201 ("conda-pin-common-deps", "/en/conda-pin-common-deps/"),
202 ("conda-env-py3.7", "/en/conda-env-py3.7/"),
203 ("conda-env-no-py-pinned", "/en/conda-env-no-py-pinned/"),
204 ("conda-env", "/en/conda-env/"),
205 ("code-injection-3", "/en/code-injection-3/"),
206 ("c-dependencies", "/en/c-dependencies/"),
207 ("build-tools-update-2", "/en/build-tools-update-2/"),
208 ("build-tools-mamba", "/en/build-tools-mamba/"),
209 ("build-tools-conda", "/en/build-tools-conda/"),
210 ("build-tools", "/en/build-tools/"),
211 ("build-os-error-message", "/en/build-os-error-message/"),
212 ("build-jobs-spaces-in-command", "/en/build-jobs-spaces-in-command/"),
213 ("build-jobs-multiline", "/en/build-jobs-multiline/"),
214 ("build-jobs-diff-exit", "/en/build-jobs-diff-exit/"),
215 ("build-jobs", "/en/build-jobs/"),
216 ("build-internals", "/en/build-internals/"),
217 ("build-commands-env-vars", "/en/build-commands-env-vars/"),
218 ("build-commands", "/en/build-commands/"),
219 ("be-default", "/en/be-default/"),
220 ("another-matching-branch", "/en/another-matching-branch/"),
221 ("annotated-tag", "/en/annotated-tag/"),
222 ("all-formats", "/en/all-formats/"),
223 ("alabaster-theme", "/en/alabaster-theme/"),
224 ("agj-test-pr", "/en/agj-test-pr/"),
225 ("agj-rtd-tf-example", "/en/agj-rtd-tf-example/"),
226 ],
227 'downloads': [
228 ],
229 'subprojects': [
230 ],
231 'slug': 'test-builds',
232 'name': u'test-builds',
233 'rtd_language': u'en',
234 'programming_language': u'words',
235 'canonical_url': 'https://test-builds.readthedocs.io/en/latest/',
236 'analytics_code': 'UA-12341234-1',
237 'single_version': False,
238 'conf_py_path': '/docs/',
239 'api_host': 'https://readthedocs.org',
240 'github_user': 'readthedocs',
241 'proxied_api_host': '/_',
242 'github_repo': 'test-builds',
243 'github_version': 'wormhole',
244 'display_github': True,
245 'bitbucket_user': 'None',
246 'bitbucket_repo': 'None',
247 'bitbucket_version': 'wormhole',
248 'display_bitbucket': False,
249 'gitlab_user': 'None',
250 'gitlab_repo': 'None',
251 'gitlab_version': 'wormhole',
252 'display_gitlab': False,
253 'READTHEDOCS': True,
254 'using_theme': (html_theme == "default"),
255 'new_theme': (html_theme == "sphinx_rtd_theme"),
256 'source_suffix': SUFFIX,
257 'ad_free': False,
258 'docsearch_disabled': False,
259 'user_analytics_code': 'UA-12341234-1',
260 'global_analytics_code': None,
261 'commit': 'c70ba6bd',
262}
263
264# For sphinx >=1.8 we can use html_baseurl to set the canonical URL.
265# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
266if version_info >= (1, 8):
267 if not globals().get('html_baseurl'):
268 html_baseurl = context['canonical_url']
269 context['canonical_url'] = None
270
271
272
273
274
275if 'html_context' in globals():
276
277 html_context.update(context)
278
279else:
280 html_context = context
281
282# Add custom RTD extension
283if 'extensions' in globals():
284 # Insert at the beginning because it can interfere
285 # with other extensions.
286 # See https://github.com/rtfd/readthedocs.org/pull/4054
287 extensions.insert(0, "readthedocs_ext.readthedocs")
288else:
289 extensions = ["readthedocs_ext.readthedocs"]
290
291# Add External version warning banner to the external version documentation
292if 'branch' == 'external':
293 extensions.insert(1, "readthedocs_ext.external_version_warning")
294 readthedocs_vcs_url = 'None'
295 readthedocs_build_url = 'https://readthedocs.org/projects/test-builds/builds/18414767/'
296
297project_language = 'en'
298
299# User's Sphinx configurations
300language_user = globals().get('language', None)
301latex_engine_user = globals().get('latex_engine', None)
302latex_elements_user = globals().get('latex_elements', None)
303
304# Remove this once xindy gets installed in Docker image and XINDYOPS
305# env variable is supported
306# https://github.com/rtfd/readthedocs-docker-images/pull/98
307latex_use_xindy = False
308
309chinese = any([
310 language_user in ('zh_CN', 'zh_TW'),
311 project_language in ('zh_CN', 'zh_TW'),
312])
313
314japanese = any([
315 language_user == 'ja',
316 project_language == 'ja',
317])
318
319if chinese:
320 latex_engine = latex_engine_user or 'xelatex'
321
322 latex_elements_rtd = {
323 'preamble': '\\usepackage[UTF8]{ctex}\n',
324 }
325 latex_elements = latex_elements_user or latex_elements_rtd
326elif japanese:
327 latex_engine = latex_engine_user or 'platex'
328
329# Make sure our build directory is always excluded
330exclude_patterns = globals().get('exclude_patterns', [])
331exclude_patterns.extend(['_build'])