conf.py

# -*- coding: utf-8 -*-

# Default settings
project = 'Test Builds'
extensions = [
    'sphinx_autorun',
]

latex_engine = 'xelatex'  # allow us to build Unicode chars


# Include all your settings here
html_theme = 'sphinx_rtd_theme'




###########################################################################
#          auto-created readthedocs.org specific configuration            #
###########################################################################


#
# The following code was added during an automated build on readthedocs.org
# It is auto created and injected for every build. The result is based on the
# conf.py.tmpl file found in the readthedocs.org codebase:
# https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#


import importlib
import sys
import os.path
from six import string_types

from sphinx import version_info

# Get suffix for proper linking to GitHub
# This is deprecated in Sphinx 1.3+,
# as each page can have its own suffix
if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    elif isinstance(source_suffix, (list, tuple)):
        # Sphinx >= 1.3 supports list/tuple to define multiple suffixes
        SUFFIX = source_suffix[0]
    elif isinstance(source_suffix, dict):
        # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes
        SUFFIX = list(source_suffix.keys())[0]  # make a ``list()`` for py2/py3 compatibility
    else:
        # default to .rst
        SUFFIX = '.rst'
else:
    SUFFIX = '.rst'

# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')

# Add RTD Theme only if they aren't overriding it already
using_rtd_theme = (
    (
        'html_theme' in globals() and
        html_theme in ['default'] and
        # Allow people to bail with a hack of having an html_style
        'html_style' not in globals()
    ) or 'html_theme' not in globals()
)
if using_rtd_theme:
    theme = importlib.import_module('sphinx_rtd_theme')
    html_theme = 'sphinx_rtd_theme'
    html_style = None
    html_theme_options = {}
    if 'html_theme_path' in globals():
        html_theme_path.append(theme.get_html_theme_path())
    else:
        html_theme_path = [theme.get_html_theme_path()]

if globals().get('websupport2_base_url', False):
    websupport2_base_url = 'https://readthedocs.org/websupport'
    websupport2_static_url = 'https://assets.readthedocs.org/static/'


#Add project information to the template context.
context = {
    'using_theme': using_rtd_theme,
    'html_theme': html_theme,
    'current_version': "latest",
    'version_slug': "latest",
    'MEDIA_URL': "https://media.readthedocs.org/",
    'STATIC_URL': "https://assets.readthedocs.org/static/",
    'PRODUCTION_DOMAIN': "readthedocs.org",
    'versions': [
    ("master", "/en/master/"),
    ("latest", "/en/latest/"),
    ("4.0", "/en/4.0/"),
    ("2.0", "/en/2.0/"),
    ("yaml-v2", "/en/yaml-v2/"),
    ("use-requirements-from-submodule", "/en/use-requirements-from-submodule/"),
    ("use-py2", "/en/use-py2/"),
    ("use-image-5.0rc1", "/en/use-image-5.0rc1/"),
    ("unicode-filename", "/en/unicode-filename/"),
    ("d--branch", "/en/d--branch/"),
    ("typlog-theme", "/en/typlog-theme/"),
    ("timetestlarge", "/en/timetestlarge/"),
    ("timetest", "/en/timetest/"),
    ("timeout", "/en/timeout/"),
    ("throw-exception", "/en/throw-exception/"),
    ("testing-image", "/en/testing-image/"),
    ("testing-activate-version", "/en/testing-activate-version/"),
    ("test-py-37", "/en/test-py-37/"),
    ("test-paths-with-spaces", "/en/test-paths-with-spaces/"),
    ("tag-v2", "/en/tag-v2/"),
    ("tag-v1", "/en/tag-v1/"),
    ("submodule-https-scheme", "/en/submodule-https-scheme/"),
    ("submodule-git-scheme", "/en/submodule-git-scheme/"),
    ("sphinx2", "/en/sphinx2/"),
    ("sphinx-es-suggest", "/en/sphinx-es-suggest/"),
    ("sphinx-3.x", "/en/sphinx-3.x/"),
    ("search-with-old-sphinx-and-theme", "/en/search-with-old-sphinx-and-theme/"),
    ("run-rust", "/en/run-rust/"),
    ("robots-txt", "/en/robots-txt/"),
    ("requirements-not-found", "/en/requirements-not-found/"),
    ("pypy3.5", "/en/pypy3.5/"),
    ("pygments-custom-lexer-apex", "/en/pygments-custom-lexer-apex/"),
    ("py3.9", "/en/py3.9/"),
    ("py3.8", "/en/py3.8/"),
    ("py3.5", "/en/py3.5/"),
    ("path-with-plus", "/en/path-with-plus/"),
    ("none-formats", "/en/none-formats/"),
    ("nbsphinx-3d-plot", "/en/nbsphinx-3d-plot/"),
    ("multiple-source-suffix", "/en/multiple-source-suffix/"),
    ("meta-tags", "/en/meta-tags/"),
    ("japanese-pdf", "/en/japanese-pdf/"),
    ("invalid-submodules", "/en/invalid-submodules/"),
    ("install-pytorch", "/en/install-pytorch/"),
    ("install-aiohttp", "/en/install-aiohttp/"),
    ("huge-build-output", "/en/huge-build-output/"),
    ("hide-me", "/en/hide-me/"),
    ("git-lfs", "/en/git-lfs/"),
    ("file-with-apostrophe", "/en/file-with-apostrophe/"),
    ("environment-variables", "/en/environment-variables/"),
    ("datetime", "/en/datetime/"),
    ("custom-404-page", "/en/custom-404-page/"),
    ("conda-satisfied-skip-solve", "/en/conda-satisfied-skip-solve/"),
    ("conda-pin-common-deps", "/en/conda-pin-common-deps/"),
    ("conda-env-py3.7", "/en/conda-env-py3.7/"),
    ("conda-env", "/en/conda-env/"),
    ("c-dependencies", "/en/c-dependencies/"),
    ("build-internals", "/en/build-internals/"),
    ("another-matching-branch", "/en/another-matching-branch/"),
    ("all-formats", "/en/all-formats/"),
    ("alabaster-theme", "/en/alabaster-theme/"),
    ],
    'downloads': [ 
    ("pdf", "//test-builds.readthedocs.io/_/downloads/en/latest/pdf/"),
    ("html", "//test-builds.readthedocs.io/_/downloads/en/latest/htmlzip/"),
    ("epub", "//test-builds.readthedocs.io/_/downloads/en/latest/epub/"),
    ],
    'subprojects': [ 
    ],
    'slug': 'test-builds',
    'name': u'test-builds',
    'rtd_language': u'en',
    'programming_language': u'words',
    'canonical_url': 'https://test-builds.readthedocs.io/en/latest/',
    'analytics_code': 'UA-12341234-1',
    'single_version': False,
    'conf_py_path': '/docs/',
    'api_host': 'https://readthedocs.org',
    'github_user': 'rtfd',
    'proxied_api_host': '/_',
    'github_repo': 'test-builds',
    'github_version': 'master',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'master',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'master',
    'display_gitlab': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'ad_free': False,
    'docsearch_disabled': False,
    'user_analytics_code': 'UA-12341234-1',
    'global_analytics_code': 'UA-17997319-1',
    'commit': '09cae390',
}




if 'html_context' in globals():
    
    html_context.update(context)
    
else:
    html_context = context

# Add custom RTD extension
if 'extensions' in globals():
    # Insert at the beginning because it can interfere
    # with other extensions.
    # See https://github.com/rtfd/readthedocs.org/pull/4054
    extensions.insert(0, "readthedocs_ext.readthedocs")
else:
    extensions = ["readthedocs_ext.readthedocs"]

# Add External version warning banner to the external version documentation
if 'branch' == 'external':
    extensions.insert(1, "readthedocs_ext.external_version_warning")

project_language = 'en'

# User's Sphinx configurations
language_user = globals().get('language', None)
latex_engine_user = globals().get('latex_engine', None)
latex_elements_user = globals().get('latex_elements', None)

# Remove this once xindy gets installed in Docker image and XINDYOPS
# env variable is supported
# https://github.com/rtfd/readthedocs-docker-images/pull/98
latex_use_xindy = False

chinese = any([
    language_user in ('zh_CN', 'zh_TW'),
    project_language in ('zh_CN', 'zh_TW'),
])

japanese = any([
    language_user == 'ja',
    project_language == 'ja',
])

if chinese:
    latex_engine = latex_engine_user or 'xelatex'

    latex_elements_rtd = {
        'preamble': '\\usepackage[UTF8]{ctex}\n',
    }
    latex_elements = latex_elements_user or latex_elements_rtd
elif japanese:
    latex_engine = latex_engine_user or 'platex'

# Make sure our build directory is always excluded
exclude_patterns = globals().get('exclude_patterns', [])
exclude_patterns.extend(['_build'])