Read the Docs build information Build id: 476055 Project: aviatrix-systems-inc-docs Version: latest Commit: 67cfe7f2cb8c2225697d8f1202c232ed546ea690 Date: 2020-11-10T17:56:40.477957Z State: finished Success: False [rtd-command-info] start-time: 2020-11-10T17:56:42.547817Z, end-time: 2020-11-10T17:56:58.254038Z, duration: 15, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/AviatrixSystems/Docs . Cloning into '.'... Checking out files: 52% (1166/2204) Checking out files: 53% (1169/2204) Checking out files: 54% (1191/2204) Checking out files: 55% (1213/2204) Checking out files: 56% (1235/2204) Checking out files: 57% (1257/2204) Checking out files: 58% (1279/2204) Checking out files: 59% (1301/2204) Checking out files: 60% (1323/2204) Checking out files: 61% (1345/2204) Checking out files: 62% (1367/2204) Checking out files: 63% (1389/2204) Checking out files: 64% (1411/2204) Checking out files: 65% (1433/2204) Checking out files: 66% (1455/2204) Checking out files: 67% (1477/2204) Checking out files: 68% (1499/2204) Checking out files: 69% (1521/2204) Checking out files: 70% (1543/2204) Checking out files: 71% (1565/2204) Checking out files: 72% (1587/2204) Checking out files: 73% (1609/2204) Checking out files: 74% (1631/2204) Checking out files: 75% (1653/2204) Checking out files: 76% (1676/2204) Checking out files: 77% (1698/2204) Checking out files: 78% (1720/2204) Checking out files: 79% (1742/2204) Checking out files: 80% (1764/2204) Checking out files: 81% (1786/2204) Checking out files: 82% (1808/2204) Checking out files: 83% (1830/2204) Checking out files: 84% (1852/2204) Checking out files: 85% (1874/2204) Checking out files: 86% (1896/2204) Checking out files: 87% (1918/2204) Checking out files: 88% (1940/2204) Checking out files: 89% (1962/2204) Checking out files: 90% (1984/2204) Checking out files: 91% (2006/2204) Checking out files: 92% (2028/2204) Checking out files: 93% (2050/2204) Checking out files: 94% (2072/2204) Checking out files: 95% (2094/2204) Checking out files: 96% (2116/2204) Checking out files: 97% (2138/2204) Checking out files: 98% (2160/2204) Checking out files: 99% (2182/2204) Checking out files: 100% (2204/2204) Checking out files: 100% (2204/2204), done. [rtd-command-info] start-time: 2020-11-10T17:56:58.958814Z, end-time: 2020-11-10T17:56:59.330788Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: checking out 'origin/master'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at 67cfe7f fix typoo with some updates [rtd-command-info] start-time: 2020-11-10T17:56:59.676538Z, end-time: 2020-11-10T17:56:59.734422Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2020-11-10T17:57:03.947167Z, end-time: 2020-11-10T17:57:07.367479Z, duration: 3, exit-code: 0 python2.7 -mvirtualenv New python executable in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/bin/python2.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2020-11-10T17:57:07.564238Z, end-time: 2020-11-10T17:57:08.225356Z, duration: 0, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip DEPRECATION: Python 2.7 reached the end of its life on January 1st, 2020. Please upgrade your Python as Python 2.7 is no longer maintained. pip 21.0 will drop support for Python 2.7 in January 2021. More details about Python 2 support in pip can be found at https://pip.pypa.io/en/latest/development/release-process/#python-2-support pip 21.0 will remove support for this functionality. Requirement already up-to-date: pip in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (20.2.4) [rtd-command-info] start-time: 2020-11-10T17:57:08.377959Z, end-time: 2020-11-10T17:57:17.000465Z, duration: 8, exit-code: 0 python -m pip install --upgrade --no-cache-dir setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.2 DEPRECATION: Python 2.7 reached the end of its life on January 1st, 2020. Please upgrade your Python as Python 2.7 is no longer maintained. pip 21.0 will drop support for Python 2.7 in January 2021. More details about Python 2 support in pip can be found at https://pip.pypa.io/en/latest/development/release-process/#python-2-support pip 21.0 will remove support for this functionality. Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) Collecting docutils==0.14 Downloading docutils-0.14-py2-none-any.whl (543 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.tar.gz (818 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp27-cp27mu-manylinux1_x86_64.whl (2.0 MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx<2 Downloading Sphinx-1.8.5-py2.py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) Collecting readthedocs-sphinx-ext<2.2 Downloading readthedocs_sphinx_ext-2.1.1-py2.py3-none-any.whl (13 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting typing; python_version < "3.5" Downloading typing-3.7.4.3-py2-none-any.whl (26 kB) Collecting Pygments>=2.0 Downloading Pygments-2.5.2-py2.py3-none-any.whl (896 kB) Collecting Jinja2>=2.3 Downloading Jinja2-2.11.2-py2.py3-none-any.whl (125 kB) Collecting packaging Downloading packaging-20.4-py2.py3-none-any.whl (37 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.0.0-py2.py3-none-any.whl (97 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.8.0-py2.py3-none-any.whl (8.6 MB) Collecting six>=1.5 Downloading six-1.15.0-py2.py3-none-any.whl (10 kB) Collecting requests>=2.0.0 Downloading requests-2.24.0-py2.py3-none-any.whl (61 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.1.2-py2.py3-none-any.whl (39 kB) Collecting MarkupSafe>=0.23 Downloading MarkupSafe-1.1.1-cp27-cp27mu-manylinux1_x86_64.whl (24 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting pytz>=2015.7 Downloading pytz-2020.4-py2.py3-none-any.whl (509 kB) Collecting certifi>=2017.4.17 Downloading certifi-2020.11.8-py2.py3-none-any.whl (155 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting chardet<4,>=3.0.2 Downloading chardet-3.0.4-py2.py3-none-any.whl (133 kB) Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 Downloading urllib3-1.25.11-py2.py3-none-any.whl (127 kB) Building wheels for collected packages: mock, future Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-py2-none-any.whl size=23754 sha256=a219fc11407a6e44d4f85373aef1dcc1d84888f9a733279a0607bc913283da87 Stored in directory: /tmp/pip-ephem-wheel-cache-wnr9qw/wheels/ad/62/e0/a06cc957652749e64c7904e899eca3ecb2ec47c60d52653660 Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py2-none-any.whl size=502566 sha256=83b2330f7aebcc84b6117d9102f69d7e22dd7ebf235f25c1d405f8dda88c14c1 Stored in directory: /tmp/pip-ephem-wheel-cache-wnr9qw/wheels/5f/11/0c/aad680baf5ef4fbcbab992c9f03e1130357e0c173a4fdabfff Successfully built mock future Installing collected packages: setuptools, docutils, mock, pillow, alabaster, future, commonmark, imagesize, typing, Pygments, MarkupSafe, Jinja2, six, pyparsing, packaging, snowballstemmer, pytz, babel, certifi, idna, chardet, urllib3, requests, sphinxcontrib-websupport, sphinx, recommonmark, sphinx-rtd-theme, readthedocs-sphinx-ext Attempting uninstall: setuptools Found existing installation: setuptools 44.1.1 Uninstalling setuptools-44.1.1: Successfully uninstalled setuptools-44.1.1 Successfully installed Jinja2-2.11.2 MarkupSafe-1.1.1 Pygments-2.5.2 alabaster-0.7.12 babel-2.8.0 certifi-2020.11.8 chardet-3.0.4 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.4 pillow-5.4.1 pyparsing-2.4.7 pytz-2020.4 readthedocs-sphinx-ext-2.1.1 recommonmark-0.5.0 requests-2.24.0 setuptools-41.0.1 six-1.15.0 snowballstemmer-2.0.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-websupport-1.1.2 typing-3.7.4.3 urllib3-1.25.11 [rtd-command-info] start-time: 2020-11-10T17:57:17.365269Z, end-time: 2020-11-10T17:57:19.309259Z, duration: 1, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements.txt DEPRECATION: Python 2.7 reached the end of its life on January 1st, 2020. Please upgrade your Python as Python 2.7 is no longer maintained. pip 21.0 will drop support for Python 2.7 in January 2021. More details about Python 2 support in pip can be found at https://pip.pypa.io/en/latest/development/release-process/#python-2-support pip 21.0 will remove support for this functionality. Collecting sphinxcontrib-disqus Downloading sphinxcontrib-disqus-1.1.0.tar.gz (5.0 kB) Collecting sphinx==1.5.5 Downloading Sphinx-1.5.5-py2.py3-none-any.whl (1.6 MB) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from sphinx==1.5.5->-r requirements.txt (line 3)) (1.2.0) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from sphinx==1.5.5->-r requirements.txt (line 3)) (2.5.2) Requirement already satisfied: docutils>=0.11 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from sphinx==1.5.5->-r requirements.txt (line 3)) (0.14) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from sphinx==1.5.5->-r requirements.txt (line 3)) (2.11.2) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from sphinx==1.5.5->-r requirements.txt (line 3)) (0.7.12) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from sphinx==1.5.5->-r requirements.txt (line 3)) (2.0.0) Requirement already satisfied: babel!=2.0,>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from sphinx==1.5.5->-r requirements.txt (line 3)) (2.8.0) Requirement already satisfied: six>=1.5 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from sphinx==1.5.5->-r requirements.txt (line 3)) (1.15.0) Requirement already satisfied: requests>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from sphinx==1.5.5->-r requirements.txt (line 3)) (2.24.0) Requirement already satisfied: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from Jinja2>=2.3->sphinx==1.5.5->-r requirements.txt (line 3)) (1.1.1) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from babel!=2.0,>=1.3->sphinx==1.5.5->-r requirements.txt (line 3)) (2020.4) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx==1.5.5->-r requirements.txt (line 3)) (2020.11.8) Requirement already satisfied: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx==1.5.5->-r requirements.txt (line 3)) (1.25.11) Requirement already satisfied: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx==1.5.5->-r requirements.txt (line 3)) (2.10) Requirement already satisfied: chardet<4,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx==1.5.5->-r requirements.txt (line 3)) (3.0.4) Building wheels for collected packages: sphinxcontrib-disqus Building wheel for sphinxcontrib-disqus (setup.py): started Building wheel for sphinxcontrib-disqus (setup.py): finished with status 'done' Created wheel for sphinxcontrib-disqus: filename=sphinxcontrib_disqus-1.1.0-py2-none-any.whl size=4665 sha256=f75077271ed4a0f982852944fbd7d40a939490b3c4b54f90d687fc73703032c1 Stored in directory: /tmp/pip-ephem-wheel-cache-0fw_Nx/wheels/dc/87/7b/ece7c20f05caf9bd4a242cc246d4a90a811f10edcd2f02645e Successfully built sphinxcontrib-disqus Installing collected packages: sphinx, sphinxcontrib-disqus Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Successfully installed sphinx-1.5.5 sphinxcontrib-disqus-1.1.0 [rtd-command-info] start-time: 2020-11-10T17:57:20.879233Z, end-time: 2020-11-10T17:57:20.949922Z, duration: 0, exit-code: 0 cat conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # aviatrix_docs documentation build configuration file, created by # sphinx-quickstart on Sun May 21 18:18:19 2017. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('.')) import sphinx_rtd_theme #from better import better_theme_path def setup(app): app.add_stylesheet('css/custom.css') app.add_javascript('js/custom.js') app.add_javascript('js/digitalpi-utm-tracker-aviatrix.com.js') app.add_javascript('js/marketo-munchkin.js') app.add_javascript('js/drift.js') # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [] #extensions = ['sphinxcontrib.disqus'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = 'aviatrix_docs' copyright = '2020, Aviatrix Systems, Inc' author = 'Aviatrix' # Options for extensions disqus_shortname = 'docs-aviatrix-com' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '' # The full version, including alpha/beta/rc tags. release = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # #html_theme = "nature" #html_theme = "alabaster" #html_theme = "haiku" html_theme = "sphinx_rtd_theme" #html_theme = 'custom' #html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] #html_theme_path = [better_theme_path] #html_theme = 'better' #html_style = 'aviatrix_theme.css' # make sure search results for relative urls link to docs.aviatrix.com html_use_opensearch = 'https://docs.aviatrix.com' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # html_theme_options = { 'logo_only': True, 'display_version': False, } # html_logo goes here, lets try this #html_logo = 'logo-aviatrix-new.png' #html_logo = 'aviatrix-logo-final - bold.png' html_logo = 'aviatrix_logo_final_reverse.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'aviatrix_docsdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'aviatrix_docs.tex', 'aviatrix\\_docs Home', 'Aviatrix Systems', 'manual'), ] # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'aviatrix_docs', 'aviatrix_docs Home', [author], 1) ] # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'aviatrix_docs', 'aviatrix_docs Home', author, 'aviatrix_docs', 'One line description of project.', 'Miscellaneous'), ] ########################################################################### # 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.com/websupport' websupport2_static_url = 'https://assets.readthedocs.com/' #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.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'versions': [ ("latest", "/en/latest/"), ], 'downloads': [ ("html", "//docs.aviatrix.com/_/downloads/en/latest/htmlzip/"), ], 'subprojects': [ ], 'slug': 'aviatrix-systems-inc-docs', 'name': u'Docs', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://docs.aviatrix.com/', 'analytics_code': 'UA-62571988-1', 'single_version': False, 'conf_py_path': '/', 'api_host': 'https://readthedocs.com', 'github_user': 'AviatrixSystems', 'proxied_api_host': '/_', 'github_repo': 'Docs', '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-62571988-1', 'global_analytics_code': 'UA-17997319-2', 'commit': '67cfe7f2', } 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'])