conf.py

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