Read the Docs build information
Build id: 1316572
Project: aviatrix-systems-inc-docs
Version: latest
Commit: 899427e4a5650862c344b60f41848bc07eef1058
Date: 2023-02-24T16:39:11.223655Z
State: cancelled
Success: False


[rtd-command-info] start-time: 2023-02-24T16:39:48.009644Z, end-time: 2023-02-24T16:40:00.817479Z, duration: 12, exit-code: 0
git clone --no-single-branch --depth 50 https://github.com/AviatrixSystems/Docs .
Cloning into '.'...
Updating files:  49% (1225/2488)
Updating files:  50% (1244/2488)
Updating files:  51% (1269/2488)
Updating files:  52% (1294/2488)
Updating files:  53% (1319/2488)
Updating files:  54% (1344/2488)
Updating files:  55% (1369/2488)
Updating files:  56% (1394/2488)
Updating files:  57% (1419/2488)
Updating files:  58% (1444/2488)
Updating files:  59% (1468/2488)
Updating files:  60% (1493/2488)
Updating files:  61% (1518/2488)
Updating files:  62% (1543/2488)
Updating files:  63% (1568/2488)
Updating files:  64% (1593/2488)
Updating files:  65% (1618/2488)
Updating files:  66% (1643/2488)
Updating files:  67% (1667/2488)
Updating files:  68% (1692/2488)
Updating files:  69% (1717/2488)
Updating files:  70% (1742/2488)
Updating files:  71% (1767/2488)
Updating files:  72% (1792/2488)
Updating files:  73% (1817/2488)
Updating files:  74% (1842/2488)
Updating files:  75% (1866/2488)
Updating files:  76% (1891/2488)
Updating files:  77% (1916/2488)
Updating files:  78% (1941/2488)
Updating files:  79% (1966/2488)
Updating files:  80% (1991/2488)
Updating files:  81% (2016/2488)
Updating files:  82% (2041/2488)
Updating files:  83% (2066/2488)
Updating files:  84% (2090/2488)
Updating files:  85% (2115/2488)
Updating files:  86% (2140/2488)
Updating files:  87% (2165/2488)
Updating files:  88% (2190/2488)
Updating files:  89% (2215/2488)
Updating files:  90% (2240/2488)
Updating files:  91% (2265/2488)
Updating files:  92% (2289/2488)
Updating files:  93% (2314/2488)
Updating files:  94% (2339/2488)
Updating files:  95% (2364/2488)
Updating files:  96% (2389/2488)
Updating files:  97% (2414/2488)
Updating files:  98% (2439/2488)
Updating files:  99% (2464/2488)
Updating files: 100% (2488/2488)
Updating files: 100% (2488/2488), done.

[rtd-command-info] start-time: 2023-02-24T16:40:01.071155Z, end-time: 2023-02-24T16:40:02.268639Z, duration: 1, exit-code: 0
git checkout --force origin/main
Note: switching to 'origin/main'.

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 switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at 899427e Update requirements.txt

[rtd-command-info] start-time: 2023-02-24T16:40:02.461141Z, end-time: 2023-02-24T16:40:02.553154Z, duration: 0, exit-code: 0
git clean -d -f -f


[rtd-command-info] start-time: 2023-02-24T16:40:05.580180Z, end-time: 2023-02-24T16:40:10.092355Z, duration: 4, exit-code: 0
python3.7 -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
Using base prefix '/home/docs/.pyenv/versions/3.7.9'
New python executable in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/bin/python3.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: 2023-02-24T16:40:10.301802Z, end-time: 2023-02-24T16:40:12.127622Z, duration: 1, exit-code: 0
python -m pip install --upgrade --no-cache-dir pip setuptools<58.3.0
Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (23.0.1)
Collecting setuptools<58.3.0
  Downloading setuptools-58.2.0-py3-none-any.whl (946 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 946.1/946.1 kB 27.0 MB/s eta 0:00:00
Installing collected packages: setuptools
  Attempting uninstall: setuptools
    Found existing installation: setuptools 67.4.0
    Uninstalling setuptools-67.4.0:
      Successfully uninstalled setuptools-67.4.0
Successfully installed setuptools-58.2.0

[rtd-command-info] start-time: 2023-02-24T16:40:12.377956Z, end-time: 2023-02-24T16:40:19.111540Z, duration: 6, exit-code: 0
python -m pip install --upgrade --no-cache-dir pillow==5.4.1 mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.3 jinja2<3.1.0
Collecting pillow==5.4.1
  Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.0/2.0 MB 36.4 MB/s eta 0:00:00
Collecting mock==1.0.1
  Downloading mock-1.0.1.zip (861 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 237.2 MB/s eta 0:00:00
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Collecting alabaster!=0.7.5,<0.8,>=0.7
  Downloading alabaster-0.7.13-py3-none-any.whl (13 kB)
Collecting commonmark==0.9.1
  Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 51.1/51.1 kB 162.2 MB/s eta 0:00:00
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.6-py2.py3-none-any.whl (3.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 183.2 MB/s eta 0:00:00
Collecting sphinx-rtd-theme<0.5
  Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.4/6.4 MB 177.9 MB/s eta 0:00:00
Collecting readthedocs-sphinx-ext<2.3
  Downloading readthedocs_sphinx_ext-2.2.0-py2.py3-none-any.whl (11 kB)
Collecting jinja2<3.1.0
  Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.6/133.6 kB 204.2 MB/s eta 0:00:00
Collecting docutils>=0.11
  Downloading docutils-0.19-py3-none-any.whl (570 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.5/570.5 kB 231.6 MB/s eta 0:00:00
Collecting packaging
  Downloading packaging-23.0-py3-none-any.whl (42 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 42.7/42.7 kB 138.4 MB/s eta 0:00:00
Collecting snowballstemmer>=1.1
  Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 178.3 MB/s eta 0:00:00
Collecting babel!=2.0,>=1.3
  Downloading Babel-2.11.0-py3-none-any.whl (9.5 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.5/9.5 MB 157.3 MB/s eta 0:00:00
Collecting imagesize
  Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB)
Collecting six>=1.5
  Downloading six-1.16.0-py2.py3-none-any.whl (11 kB)
Collecting requests>=2.0.0
  Downloading requests-2.28.2-py3-none-any.whl (62 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.8/62.8 kB 160.4 MB/s eta 0:00:00
Collecting Pygments>=2.0
  Downloading Pygments-2.14.0-py3-none-any.whl (1.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 243.3 MB/s eta 0:00:00
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx<2) (58.2.0)
Collecting docutils>=0.11
  Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 236.2 MB/s eta 0:00:00
Collecting sphinxcontrib-websupport
  Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB)
Collecting MarkupSafe>=2.0
  Downloading MarkupSafe-2.1.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB)
Collecting pytz>=2015.7
  Downloading pytz-2022.7.1-py2.py3-none-any.whl (499 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 499.4/499.4 kB 233.6 MB/s eta 0:00:00
Collecting charset-normalizer<4,>=2
  Downloading charset_normalizer-3.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (170 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 170.5/170.5 kB 216.8 MB/s eta 0:00:00
Collecting idna<4,>=2.5
  Downloading idna-3.4-py3-none-any.whl (61 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 177.6 MB/s eta 0:00:00
Collecting certifi>=2017.4.17
  Downloading certifi-2022.12.7-py3-none-any.whl (155 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 155.3/155.3 kB 216.4 MB/s eta 0:00:00
Collecting urllib3<1.27,>=1.21.1
  Downloading urllib3-1.26.14-py2.py3-none-any.whl (140 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 140.6/140.6 kB 211.1 MB/s eta 0:00:00
Collecting sphinxcontrib-serializinghtml
  Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 199.8 MB/s eta 0:00:00
Building wheels for collected packages: mock
  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-py3-none-any.whl size=23772 sha256=b60d3b6647f740c77bf90c03b0db1f13001afa46fc74a7fecb19aa553e6abc58
  Stored in directory: /tmp/pip-ephem-wheel-cache-6yozvd_4/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1
Successfully built mock
Installing collected packages: snowballstemmer, pytz, mock, commonmark, charset-normalizer, urllib3, sphinxcontrib-serializinghtml, six, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, certifi, babel, alabaster, sphinxcontrib-websupport, requests, jinja2, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark
Successfully installed MarkupSafe-2.1.2 Pygments-2.14.0 alabaster-0.7.13 babel-2.11.0 certifi-2022.12.7 charset-normalizer-3.0.1 commonmark-0.9.1 docutils-0.17.1 idna-3.4 imagesize-1.4.1 jinja2-3.0.3 mock-1.0.1 packaging-23.0 pillow-5.4.1 pytz-2022.7.1 readthedocs-sphinx-ext-2.2.0 recommonmark-0.5.0 requests-2.28.2 six-1.16.0 snowballstemmer-2.2.0 sphinx-1.8.6 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-1.26.14

[rtd-command-info] start-time: 2023-02-24T16:40:19.316276Z, end-time: 2023-02-24T16:40:20.801021Z, duration: 1, exit-code: 0
python -m pip install --exists-action=w --no-cache-dir -r requirements.txt
Collecting sphinxcontrib-disqus
  Downloading sphinxcontrib-disqus-1.1.1.tar.gz (1.7 kB)
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Requirement already satisfied: docutils<0.18 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from -r requirements.txt (line 5)) (0.17.1)
Collecting sphinx-disqus
  Downloading sphinx_disqus-1.2.0-py3-none-any.whl (6.3 kB)
Requirement already satisfied: sphinx in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (1.8.6)
Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (2.2.0)
Requirement already satisfied: sphinxcontrib-websupport in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (1.2.4)
Requirement already satisfied: babel!=2.0,>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (2.11.0)
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (58.2.0)
Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (2.14.0)
Requirement already satisfied: requests>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (2.28.2)
Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (3.0.3)
Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (23.0)
Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (0.7.13)
Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (1.4.1)
Requirement already satisfied: six>=1.5 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (1.16.0)
Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from babel!=2.0,>=1.3->sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (2022.7.1)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (2.1.2)
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from requests>=2.0.0->sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (2022.12.7)
Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from requests>=2.0.0->sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (3.0.1)
Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from requests>=2.0.0->sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (1.26.14)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from requests>=2.0.0->sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (3.4)
Requirement already satisfied: sphinxcontrib-serializinghtml in /home/docs/checkouts/readthedocs.org/user_builds/aviatrix-systems-inc-docs/envs/latest/lib/python3.7/site-packages (from sphinxcontrib-websupport->sphinx->sphinx-disqus->sphinxcontrib-disqus->-r requirements.txt (line 1)) (1.1.5)
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.1-py3-none-any.whl size=1898 sha256=a832d24b36f457edc577a37a649ed5abfe6c8f9673040ec0d2e03741af3cb2fe
  Stored in directory: /tmp/pip-ephem-wheel-cache-fx3mgpfm/wheels/3e/71/48/c4c013e6ebbfceab190b379d93533ee19460befebe0cd6bebb
Successfully built sphinxcontrib-disqus
Installing collected packages: sphinx-disqus, sphinxcontrib-disqus
Successfully installed sphinx-disqus-1.2.0 sphinxcontrib-disqus-1.1.1

[rtd-command-info] start-time: 2023-02-24T16:40:22.330030Z, end-time: 2023-02-24T16:40:22.388613Z, 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/6sense.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 = '2022, 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/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#
# Note: this file shouldn't rely on extra dependencies.

import importlib
import sys
import os.path

# Borrowed from six.
PY3 = sys.version_info[0] == 3
string_types = str if PY3 else basestring

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:
    html_theme = 'sphinx_rtd_theme'
    html_style = None
    html_theme_options = {}


# This following legacy behavior will gradually be sliced out until its deprecated and removed.
# Skipped for Sphinx 6+
# Skipped by internal Feature flag SKIP_SPHINX_HTML_THEME_PATH
# Skipped by all new projects since SKIP_SPHINX_HTML_THEME_PATH's introduction (jan 2023)
if (
        using_rtd_theme
        and version_info < (6,0)
        and not False
    ):
    theme = importlib.import_module('sphinx_rtd_theme')
    if 'html_theme_path' in globals():
        html_theme_path.append(theme.get_html_theme_path())
    else:
        html_theme_path = [theme.get_html_theme_path()]

# Define websupport2_base_url and websupport2_static_url
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",
    'proxied_static_path': "/_/static/",
    'versions': [
    ("latest", "/en/latest/"),
    ("main", "/en/main/"),
    ],
    'downloads': [ 
    ],
    'subprojects': [ 
    ],
    'slug': 'aviatrix-systems-inc-docs',
    'name': u'Docs',
    'rtd_language': u'en',
    'programming_language': u'words',
    'canonical_url': 'https://read.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': 'main',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'main',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'main',
    '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': '899427e4',
}

# For sphinx >=1.8 we can use html_baseurl to set the canonical URL.
# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
if version_info >= (1, 8):
    if not globals().get('html_baseurl'):
        html_baseurl = context['canonical_url']
    context['canonical_url'] = None





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")
    readthedocs_vcs_url = 'None'
    readthedocs_build_url = 'https://readthedocs.com/projects/aviatrix-systems-inc-docs/builds/1316572/'

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'])