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