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 html_theme = 'sphinx_rtd_theme'
76 html_style = None
77 html_theme_options = {}
78
79
80# This following legacy behavior will gradually be sliced out until its deprecated and removed.
81# Skipped for Sphinx 6+
82# Skipped by internal Feature flag SKIP_SPHINX_HTML_THEME_PATH
83# Skipped by all new projects since SKIP_SPHINX_HTML_THEME_PATH's introduction (jan 2023)
84if (
85 using_rtd_theme
86 and version_info < (6,0)
87 and not False
88 ):
89 theme = importlib.import_module('sphinx_rtd_theme')
90 if 'html_theme_path' in globals():
91 html_theme_path.append(theme.get_html_theme_path())
92 else:
93 html_theme_path = [theme.get_html_theme_path()]
94
95# Define websupport2_base_url and websupport2_static_url
96if globals().get('websupport2_base_url', False):
97 websupport2_base_url = 'https://readthedocs.org/websupport'
98 websupport2_static_url = 'https://assets.readthedocs.org/static/'
99
100
101#Add project information to the template context.
102context = {
103 'using_theme': using_rtd_theme,
104 'html_theme': html_theme,
105 'current_version': "no-pr-build",
106 'version_slug': "no-pr-build",
107 'MEDIA_URL': "https://media.readthedocs.org/",
108 'STATIC_URL': "https://assets.readthedocs.org/static/",
109 'PRODUCTION_DOMAIN': "readthedocs.org",
110 'proxied_static_path': "/_/static/",
111 'versions': [
112 ("latest", "/es/latest/"),
113 ("stable", "/es/stable/"),
114 ("5.0", "/es/5.0/"),
115 ("4.0", "/es/4.0/"),
116 ("wormhole", "/es/wormhole/"),
117 ("ubuntu-22.04", "/es/ubuntu-22.04/"),
118 ("ubuntu-20.04-python-3.9", "/es/ubuntu-20.04-python-3.9/"),
119 ("ubuntu-20.04", "/es/ubuntu-20.04/"),
120 ("theme-1.0rc1", "/es/theme-1.0rc1/"),
121 ("test-ubuntu-20.04", "/es/test-ubuntu-20.04/"),
122 ("test-rebased-commit", "/es/test-rebased-commit/"),
123 ("test-auto-cancel", "/es/test-auto-cancel/"),
124 ("template-config-file", "/es/template-config-file/"),
125 ("symlink-via-zipfile", "/es/symlink-via-zipfile/"),
126 ("sudo-commands", "/es/sudo-commands/"),
127 ("submodule-not-found", "/es/submodule-not-found/"),
128 ("staticrypt", "/es/staticrypt/"),
129 ("sphinx-tectonic-pdf", "/es/sphinx-tectonic-pdf/"),
130 ("sphinx-multipage-html", "/es/sphinx-multipage-html/"),
131 ("sphinx-mkdocstrings", "/es/sphinx-mkdocstrings/"),
132 ("sphinx-hoverxref", "/es/sphinx-hoverxref/"),
133 ("sphinx-fork", "/es/sphinx-fork/"),
134 ("sphinx-docs-zundler", "/es/sphinx-docs-zundler/"),
135 ("sphinx-conf-nonstandard", "/es/sphinx-conf-nonstandard/"),
136 ("sphinx-7.0.x", "/es/sphinx-7.0.x/"),
137 ("sphinx6.x-default", "/es/sphinx6.x-default/"),
138 ("sphinx5.x-default-confpy", "/es/sphinx5.x-default-confpy/"),
139 ("sphinx-5.x", "/es/sphinx-5.x/"),
140 ("sphinx-1.8", "/es/sphinx-1.8/"),
141 ("sphinx-1.7", "/es/sphinx-1.7/"),
142 ("sphinx-1.6", "/es/sphinx-1.6/"),
143 ("skip-build-command-pr-test3", "/es/skip-build-command-pr-test3/"),
144 ("skip-build-command-pr-test2", "/es/skip-build-command-pr-test2/"),
145 ("skip-build-command-pr-test", "/es/skip-build-command-pr-test/"),
146 ("skip-build-command", "/es/skip-build-command/"),
147 ("singlehtml", "/es/singlehtml/"),
148 ("shot-scraper", "/es/shot-scraper/"),
149 ("search-special-chars", "/es/search-special-chars/"),
150 ("rust", "/es/rust/"),
151 ("rtd-sphinx-ext", "/es/rtd-sphinx-ext/"),
152 ("robots-txt", "/es/robots-txt/"),
153 ("regular-404-page", "/es/regular-404-page/"),
154 ("recommonmark", "/es/recommonmark/"),
155 ("readthedocs-docs-build-commands", "/es/readthedocs-docs-build-commands/"),
156 ("py3.11a", "/es/py3.11a/"),
157 ("py3.11", "/es/py3.11/"),
158 ("py3.10", "/es/py3.10/"),
159 ("pr-visual-diff", "/es/pr-visual-diff/"),
160 ("pr-test", "/es/pr-test/"),
161 ("pr-readthedocs_output", "/es/pr-readthedocs_output/"),
162 ("pr-js-client", "/es/pr-js-client/"),
163 ("pr-homepage-edition", "/es/pr-homepage-edition/"),
164 ("poetry-asdf", "/es/poetry-asdf/"),
165 ("poetry", "/es/poetry/"),
166 ("pelican", "/es/pelican/"),
167 ("pdf-rinohtype", "/es/pdf-rinohtype/"),
168 ("pdf-cmd-fail", "/es/pdf-cmd-fail/"),
169 ("ooops-all-json", "/es/ooops-all-json/"),
170 ("old-output-directory", "/es/old-output-directory/"),
171 ("no-pr-build", "/es/no-pr-build/"),
172 ("no-conf-py", "/es/no-conf-py/"),
173 ("no-config-file", "/es/no-config-file/"),
174 ("monorepo", "/es/monorepo/"),
175 ("mkdocs-pdf", "/es/mkdocs-pdf/"),
176 ("mkdocs-material", "/es/mkdocs-material/"),
177 ("mkdocs-htmlzip", "/es/mkdocs-htmlzip/"),
178 ("mkdocs-config-at-root", "/es/mkdocs-config-at-root/"),
179 ("mkdocs", "/es/mkdocs/"),
180 ("manual-integrations", "/es/manual-integrations/"),
181 ("manual-integration-docsify", "/es/manual-integration-docsify/"),
182 ("mamba", "/es/mamba/"),
183 ("main", "/es/main/"),
184 ("linkcheck", "/es/linkcheck/"),
185 ("jupyter-notebook", "/es/jupyter-notebook/"),
186 ("jupyter-book", "/es/jupyter-book/"),
187 ("jsdoc-autoapi", "/es/jsdoc-autoapi/"),
188 ("jsdoc", "/es/jsdoc/"),
189 ("invalid-docker-image", "/es/invalid-docker-image/"),
190 ("install-setuptools", "/es/install-setuptools/"),
191 ("image", "/es/image/"),
192 ("humitos-poetry", "/es/humitos-poetry/"),
193 ("git-submodules-invalid", "/es/git-submodules-invalid/"),
194 ("git-submodules", "/es/git-submodules/"),
195 ("git-lfs-build-jobs", "/es/git-lfs-build-jobs/"),
196 ("furo", "/es/furo/"),
197 ("expose-env-pip-error", "/es/expose-env-pip-error/"),
198 ("explicit-flyout-placement", "/es/explicit-flyout-placement/"),
199 ("expirement", "/es/expirement/"),
200 ("envvar-config-file", "/es/envvar-config-file/"),
201 ("docusaurus", "/es/docusaurus/"),
202 ("docsify-ads", "/es/docsify-ads/"),
203 ("docsify", "/es/docsify/"),
204 ("delete-sources", "/es/delete-sources/"),
205 ("d2lbook", "/es/d2lbook/"),
206 ("custom-404-page", "/es/custom-404-page/"),
207 ("csrf", "/es/csrf/"),
208 ("build-tools-update-2", "/es/build-tools-update-2/"),
209 ("build-tools-mamba", "/es/build-tools-mamba/"),
210 ("build-tools-conda", "/es/build-tools-conda/"),
211 ("build-tools", "/es/build-tools/"),
212 ("build-os-error-message", "/es/build-os-error-message/"),
213 ("build-latest-python-3.8", "/es/build-latest-python-3.8/"),
214 ("build-jobs-spaces-in-command", "/es/build-jobs-spaces-in-command/"),
215 ("build-jobs-post-build", "/es/build-jobs-post-build/"),
216 ("build-jobs-multiline", "/es/build-jobs-multiline/"),
217 ("build-jobs-diff-exit", "/es/build-jobs-diff-exit/"),
218 ("build-jobs", "/es/build-jobs/"),
219 ("build-commands-multiline", "/es/build-commands-multiline/"),
220 ("build-commands-env-vars", "/es/build-commands-env-vars/"),
221 ("build-commands", "/es/build-commands/"),
222 ("bare-commands", "/es/bare-commands/"),
223 ("all-formats-build-jobs", "/es/all-formats-build-jobs/"),
224 ("all-formats-build-commands", "/es/all-formats-build-commands/"),
225 ("agj-test-pr", "/es/agj-test-pr/"),
226 ("agj-rtd-tf-example", "/es/agj-rtd-tf-example/"),
227 ],
228 'downloads': [
229 ],
230 'subprojects': [
231 ("stsewd-demo", "https://test.org.stsewd.dev/projects/stsewd-demo/en/custom-404-page/"),
232 ],
233 'slug': 'another-test-stsewd',
234 'name': u'another-test-stsewd',
235 'rtd_language': u'es',
236 'programming_language': u'words',
237 'canonical_url': 'https://test.org.stsewd.dev/es/latest/',
238 'analytics_code': 'None',
239 'single_version': False,
240 'conf_py_path': '/docs/',
241 'api_host': 'https://readthedocs.org',
242 'github_user': 'readthedocs',
243 'proxied_api_host': '/_',
244 'github_repo': 'test-builds',
245 'github_version': 'no-pr-build',
246 'display_github': True,
247 'bitbucket_user': 'None',
248 'bitbucket_repo': 'None',
249 'bitbucket_version': 'no-pr-build',
250 'display_bitbucket': False,
251 'gitlab_user': 'None',
252 'gitlab_repo': 'None',
253 'gitlab_version': 'no-pr-build',
254 'display_gitlab': False,
255 'READTHEDOCS': True,
256 'using_theme': (html_theme == "default"),
257 'new_theme': (html_theme == "sphinx_rtd_theme"),
258 'source_suffix': SUFFIX,
259 'ad_free': False,
260 'docsearch_disabled': False,
261 'user_analytics_code': '',
262 'global_analytics_code': 'UA-17997319-1',
263 'commit': 'c5cda932',
264}
265
266# For sphinx >=1.8 we can use html_baseurl to set the canonical URL.
267# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
268if version_info >= (1, 8):
269 if not globals().get('html_baseurl'):
270 html_baseurl = context['canonical_url']
271 context['canonical_url'] = None
272
273
274
275
276
277if 'html_context' in globals():
278
279 for key in context:
280 if key not in html_context:
281 html_context[key] = context[key]
282
283else:
284 html_context = context
285
286# Add custom RTD extension
287if 'extensions' in globals():
288 # Insert at the beginning because it can interfere
289 # with other extensions.
290 # See https://github.com/rtfd/readthedocs.org/pull/4054
291 extensions.insert(0, "readthedocs_ext.readthedocs")
292else:
293 extensions = ["readthedocs_ext.readthedocs"]
294
295# Add External version warning banner to the external version documentation
296if 'branch' == 'external':
297 extensions.insert(1, "readthedocs_ext.external_version_warning")
298 readthedocs_vcs_url = 'None'
299 readthedocs_build_url = 'https://readthedocs.org/projects/another-test-stsewd/builds/20955354/'
300
301project_language = 'es'
302
303# User's Sphinx configurations
304language_user = globals().get('language', None)
305latex_engine_user = globals().get('latex_engine', None)
306latex_elements_user = globals().get('latex_elements', None)
307
308# Remove this once xindy gets installed in Docker image and XINDYOPS
309# env variable is supported
310# https://github.com/rtfd/readthedocs-docker-images/pull/98
311latex_use_xindy = False
312
313chinese = any([
314 language_user in ('zh_CN', 'zh_TW'),
315 project_language in ('zh_CN', 'zh_TW'),
316])
317
318japanese = any([
319 language_user == 'ja',
320 project_language == 'ja',
321])
322
323if chinese:
324 latex_engine = latex_engine_user or 'xelatex'
325
326 latex_elements_rtd = {
327 'preamble': '\\usepackage[UTF8]{ctex}\n',
328 }
329 latex_elements = latex_elements_user or latex_elements_rtd
330elif japanese:
331 latex_engine = latex_engine_user or 'platex'
332
333# Make sure our build directory is always excluded
334exclude_patterns = globals().get('exclude_patterns', [])
335exclude_patterns.extend(['_build'])