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