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