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