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': "sphinx-fork",
94 'version_slug': "sphinx-fork",
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", "/es/latest/"),
101 ("stable", "/es/stable/"),
102 ("5.0", "/es/5.0/"),
103 ("4.0", "/es/4.0/"),
104 ("ubuntu-22.04", "/es/ubuntu-22.04/"),
105 ("theme-1.0rc1", "/es/theme-1.0rc1/"),
106 ("sudo-commands", "/es/sudo-commands/"),
107 ("sphinx-fork", "/es/sphinx-fork/"),
108 ("sphinx-5.x", "/es/sphinx-5.x/"),
109 ("sphinx-1.8", "/es/sphinx-1.8/"),
110 ("sphinx-1.7", "/es/sphinx-1.7/"),
111 ("sphinx-1.6", "/es/sphinx-1.6/"),
112 ("rust", "/es/rust/"),
113 ("rtd-sphinx-ext", "/es/rtd-sphinx-ext/"),
114 ("robots-txt", "/es/robots-txt/"),
115 ("py3.11a", "/es/py3.11a/"),
116 ("py3.11", "/es/py3.11/"),
117 ("py3.10", "/es/py3.10/"),
118 ("poetry-asdf", "/es/poetry-asdf/"),
119 ("poetry", "/es/poetry/"),
120 ("pelican", "/es/pelican/"),
121 ("ooops-all-json", "/es/ooops-all-json/"),
122 ("no-config-file", "/es/no-config-file/"),
123 ("mamba", "/es/mamba/"),
124 ("main", "/es/main/"),
125 ("jsdoc-autoapi", "/es/jsdoc-autoapi/"),
126 ("jsdoc", "/es/jsdoc/"),
127 ("image", "/es/image/"),
128 ("humitos-poetry", "/es/humitos-poetry/"),
129 ("git-submodules", "/es/git-submodules/"),
130 ("git-lfs-build-jobs", "/es/git-lfs-build-jobs/"),
131 ("expose-env-pip-error", "/es/expose-env-pip-error/"),
132 ("csrf", "/es/csrf/"),
133 ("build-tools-update-2", "/es/build-tools-update-2/"),
134 ("build-tools-mamba", "/es/build-tools-mamba/"),
135 ("build-tools-conda", "/es/build-tools-conda/"),
136 ("build-tools", "/es/build-tools/"),
137 ("build-os-error-message", "/es/build-os-error-message/"),
138 ("build-jobs-multiline", "/es/build-jobs-multiline/"),
139 ("build-jobs", "/es/build-jobs/"),
140 ("build-commands", "/es/build-commands/"),
141 ("agj-test-pr", "/es/agj-test-pr/"),
142 ("agj-rtd-tf-example", "/es/agj-rtd-tf-example/"),
143 ],
144 'downloads': [
145 ],
146 'subprojects': [
147 ("stsewd-demo", "https://another-test-stsewd.readthedocs.io/projects/stsewd-demo/en/stable/"),
148 ],
149 'slug': 'another-test-stsewd',
150 'name': u'another-test-stsewd',
151 'rtd_language': u'es',
152 'programming_language': u'words',
153 'canonical_url': 'https://another-test-stsewd.readthedocs.io/es/latest/',
154 'analytics_code': 'None',
155 'single_version': False,
156 'conf_py_path': '/docs/',
157 'api_host': 'https://readthedocs.org',
158 'github_user': 'rtfd',
159 'proxied_api_host': '/_',
160 'github_repo': 'test-builds',
161 'github_version': 'sphinx-fork',
162 'display_github': True,
163 'bitbucket_user': 'None',
164 'bitbucket_repo': 'None',
165 'bitbucket_version': 'sphinx-fork',
166 'display_bitbucket': False,
167 'gitlab_user': 'None',
168 'gitlab_repo': 'None',
169 'gitlab_version': 'sphinx-fork',
170 'display_gitlab': False,
171 'READTHEDOCS': True,
172 'using_theme': (html_theme == "default"),
173 'new_theme': (html_theme == "sphinx_rtd_theme"),
174 'source_suffix': SUFFIX,
175 'ad_free': False,
176 'docsearch_disabled': False,
177 'user_analytics_code': '',
178 'global_analytics_code': 'UA-17997319-1',
179 'commit': 'aabd5195',
180}
181
182# For sphinx >=1.8 we can use html_baseurl to set the canonical URL.
183# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
184if version_info >= (1, 8):
185 if not globals().get('html_baseurl'):
186 html_baseurl = context['canonical_url']
187 context['canonical_url'] = None
188
189
190
191
192
193if 'html_context' in globals():
194
195 html_context.update(context)
196
197else:
198 html_context = context
199
200# Add custom RTD extension
201if 'extensions' in globals():
202 # Insert at the beginning because it can interfere
203 # with other extensions.
204 # See https://github.com/rtfd/readthedocs.org/pull/4054
205 extensions.insert(0, "readthedocs_ext.readthedocs")
206else:
207 extensions = ["readthedocs_ext.readthedocs"]
208
209# Add External version warning banner to the external version documentation
210if 'branch' == 'external':
211 extensions.insert(1, "readthedocs_ext.external_version_warning")
212 readthedocs_vcs_url = 'None'
213 readthedocs_build_url = 'https://readthedocs.org/projects/another-test-stsewd/builds/17230676/'
214
215project_language = 'es'
216
217# User's Sphinx configurations
218language_user = globals().get('language', None)
219latex_engine_user = globals().get('latex_engine', None)
220latex_elements_user = globals().get('latex_elements', None)
221
222# Remove this once xindy gets installed in Docker image and XINDYOPS
223# env variable is supported
224# https://github.com/rtfd/readthedocs-docker-images/pull/98
225latex_use_xindy = False
226
227chinese = any([
228 language_user in ('zh_CN', 'zh_TW'),
229 project_language in ('zh_CN', 'zh_TW'),
230])
231
232japanese = any([
233 language_user == 'ja',
234 project_language == 'ja',
235])
236
237if chinese:
238 latex_engine = latex_engine_user or 'xelatex'
239
240 latex_elements_rtd = {
241 'preamble': '\\usepackage[UTF8]{ctex}\n',
242 }
243 latex_elements = latex_elements_user or latex_elements_rtd
244elif japanese:
245 latex_engine = latex_engine_user or 'platex'
246
247# Make sure our build directory is always excluded
248exclude_patterns = globals().get('exclude_patterns', [])
249exclude_patterns.extend(['_build'])