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': "latest",
 94    'version_slug': "latest",
 95    'MEDIA_URL': "https://media.readthedocs.org/",
 96    'STATIC_URL': "https://assets.readthedocs.org/static/",
 97    'PRODUCTION_DOMAIN': "readthedocs.org",
 98    'versions': [
 99    ("latest", "/es/latest/"),
100    ("stable", "/es/stable/"),
101    ],
102    'downloads': [ 
103    ],
104    'subprojects': [ 
105    ],
106    'slug': 'test-translation-es',
107    'name': u'test-translation-es',
108    'rtd_language': u'es',
109    'programming_language': u'words',
110    'canonical_url': 'https://test-translation.readthedocs.io/es/latest/',
111    'analytics_code': 'None',
112    'single_version': False,
113    'conf_py_path': '/docs/',
114    'api_host': 'https://readthedocs.org',
115    'github_user': 'readthedocs',
116    'proxied_api_host': '/_',
117    'github_repo': 'test-builds',
118    'github_version': 'main',
119    'display_github': True,
120    'bitbucket_user': 'None',
121    'bitbucket_repo': 'None',
122    'bitbucket_version': 'main',
123    'display_bitbucket': False,
124    'gitlab_user': 'None',
125    'gitlab_repo': 'None',
126    'gitlab_version': 'main',
127    'display_gitlab': False,
128    'READTHEDOCS': True,
129    'using_theme': (html_theme == "default"),
130    'new_theme': (html_theme == "sphinx_rtd_theme"),
131    'source_suffix': SUFFIX,
132    'ad_free': False,
133    'docsearch_disabled': False,
134    'user_analytics_code': '',
135    'global_analytics_code': 'UA-17997319-1',
136    'commit': 'bbfc9916',
137}
138
139# For sphinx >=1.8 we can use html_baseurl to set the canonical URL.
140# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
141if version_info >= (1, 8):
142    if not globals().get('html_baseurl'):
143        html_baseurl = context['canonical_url']
144    context['canonical_url'] = None
145
146
147
148
149
150if 'html_context' in globals():
151    
152    html_context.update(context)
153    
154else:
155    html_context = context
156
157# Add custom RTD extension
158if 'extensions' in globals():
159    # Insert at the beginning because it can interfere
160    # with other extensions.
161    # See https://github.com/rtfd/readthedocs.org/pull/4054
162    extensions.insert(0, "readthedocs_ext.readthedocs")
163else:
164    extensions = ["readthedocs_ext.readthedocs"]
165
166# Add External version warning banner to the external version documentation
167if 'branch' == 'external':
168    extensions.insert(1, "readthedocs_ext.external_version_warning")
169    readthedocs_vcs_url = 'None'
170    readthedocs_build_url = 'https://readthedocs.org/projects/test-translation-es/builds/16752466/'
171
172project_language = 'es'
173
174# User's Sphinx configurations
175language_user = globals().get('language', None)
176latex_engine_user = globals().get('latex_engine', None)
177latex_elements_user = globals().get('latex_elements', None)
178
179# Remove this once xindy gets installed in Docker image and XINDYOPS
180# env variable is supported
181# https://github.com/rtfd/readthedocs-docker-images/pull/98
182latex_use_xindy = False
183
184chinese = any([
185    language_user in ('zh_CN', 'zh_TW'),
186    project_language in ('zh_CN', 'zh_TW'),
187])
188
189japanese = any([
190    language_user == 'ja',
191    project_language == 'ja',
192])
193
194if chinese:
195    latex_engine = latex_engine_user or 'xelatex'
196
197    latex_elements_rtd = {
198        'preamble': '\\usepackage[UTF8]{ctex}\n',
199    }
200    latex_elements = latex_elements_user or latex_elements_rtd
201elif japanese:
202    latex_engine = latex_engine_user or 'platex'
203
204# Make sure our build directory is always excluded
205exclude_patterns = globals().get('exclude_patterns', [])
206exclude_patterns.extend(['_build'])