Read the Docs build information
Build id: 1266646
Project: espressif-esp-rainmaker
Version: latest
Commit: f502deee029736e5d364142701b8dd044eadadb3
Date: 2023-01-24T12:27:37.677288Z
State: cancelled
Success: False


[rtd-command-info] start-time: 2023-01-24T12:27:39.766133Z, end-time: 2023-01-24T12:27:41.187036Z, duration: 1, exit-code: 0
git clone --no-single-branch --depth 50 git@github.com:espressif/esp-rainmaker.git .
Cloning into '.'...
Warning: Permanently added 'github.com,192.30.255.113' (ECDSA) to the list of known hosts.

[rtd-command-info] start-time: 2023-01-24T12:27:41.485230Z, end-time: 2023-01-24T12:27:41.582127Z, duration: 0, exit-code: 0
git checkout --force origin/master
Note: switching to '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 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 f502dee Merge branch 'support/cmd_resp_enabed_chk' into 'master'

[rtd-command-info] start-time: 2023-01-24T12:27:41.813959Z, end-time: 2023-01-24T12:27:41.882975Z, duration: 0, exit-code: 0
git clean -d -f -f


[rtd-command-info] start-time: 2023-01-24T12:27:42.121039Z, end-time: 2023-01-24T12:27:42.206086Z, duration: 0, exit-code: 0
git submodule sync


[rtd-command-info] start-time: 2023-01-24T12:27:42.460309Z, end-time: 2023-01-24T12:27:46.929818Z, duration: 4, exit-code: 0
git submodule update --init --force components/json_parser/upstream components/json_generator/upstream components/rmaker_common cli components/esp-insights
Submodule 'cli' (git@github.com:espressif/esp-rainmaker-cli.git) registered for path 'cli'
Submodule 'components/esp-insights' (git@github.com:espressif/esp-insights.git) registered for path 'components/esp-insights'
Submodule 'components/json_generator/upstream' (https://github.com/espressif/json_generator.git) registered for path 'components/json_generator/upstream'
Submodule 'components/json_parser/upstream' (https://github.com/espressif/json_parser.git) registered for path 'components/json_parser/upstream'
Submodule 'components/rmaker_common' (git@github.com:espressif/esp-rainmaker-common.git) registered for path 'components/rmaker_common'
Cloning into '/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/checkouts/latest/cli'...
Warning: Permanently added 'github.com,192.30.255.113' (ECDSA) to the list of known hosts.
Cloning into '/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/checkouts/latest/components/esp-insights'...
Warning: Permanently added 'github.com,192.30.255.113' (ECDSA) to the list of known hosts.
Cloning into '/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/checkouts/latest/components/json_generator/upstream'...
Cloning into '/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/checkouts/latest/components/json_parser/upstream'...
Cloning into '/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/checkouts/latest/components/rmaker_common'...
Warning: Permanently added 'github.com,192.30.255.113' (ECDSA) to the list of known hosts.
Submodule path 'cli': checked out '85e712416121ea739e320e301058ebc97ca862f8'
Submodule path 'components/esp-insights': checked out 'd21bfb3854e057adc65bf4403d2da3f0f2231020'
Submodule path 'components/json_generator/upstream': checked out '17507cce331e8e2056593dc01f5adf0a8b6f63ef'
Submodule path 'components/json_parser/upstream': checked out '8a60b7aa5e9b790686a73c4f992bf0b988a45b7f'
Submodule path 'components/rmaker_common': checked out 'a64ad7a6806c242de468a8fa72e801d634403442'

[rtd-command-info] start-time: 2023-01-24T12:27:48.056561Z, end-time: 2023-01-24T12:27:52.641106Z, duration: 4, exit-code: 0
python3.7 -mvirtualenv 
Using base prefix '/home/docs/.pyenv/versions/3.7.9'
New python executable in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/bin/python3.7
Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/bin/python
Installing setuptools, pip, wheel...
done.

[rtd-command-info] start-time: 2023-01-24T12:27:52.848377Z, end-time: 2023-01-24T12:27:54.615292Z, 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/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (22.3.1)
Collecting setuptools<58.3.0
  Downloading setuptools-58.2.0-py3-none-any.whl (946 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 946.1/946.1 kB 32.8 MB/s eta 0:00:00
Installing collected packages: setuptools
  Attempting uninstall: setuptools
    Found existing installation: setuptools 66.1.1
    Uninstalling setuptools-66.1.1:
      Successfully uninstalled setuptools-66.1.1
Successfully installed setuptools-58.2.0

[rtd-command-info] start-time: 2023-01-24T12:27:54.835237Z, end-time: 2023-01-24T12:28:01.325470Z, 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 43.8 MB/s eta 0:00:00
Collecting mock==1.0.1
  Downloading mock-1.0.1.zip (861 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 236.5 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 173.3 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 203.6 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 197.6 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 209.1 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 237.7 MB/s eta 0:00:00
  Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 235.7 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 235.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 182.8 MB/s eta 0:00:00
Collecting requests>=2.0.0
  Downloading requests-2.28.2-py3-none-any.whl (62 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.8/62.8 kB 178.9 MB/s eta 0:00:00
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx<2) (58.2.0)
Collecting packaging
  Downloading packaging-23.0-py3-none-any.whl (42 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 42.7/42.7 kB 160.9 MB/s eta 0:00:00
Collecting sphinxcontrib-websupport
  Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB)
Collecting snowballstemmer>=1.1
  Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 186.4 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 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 235.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 181.7 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 223.5 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 207.9 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 220.5 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 181.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=44239f9f9e2ad54df33981f7915f3c8cae61a1b84c7fdce565e54447955d776e
  Stored in directory: /tmp/pip-ephem-wheel-cache-g8y9rvwb/wheels/d1/33/8e/f9d24f00cc130866aacfe7c3bc15571217e2b22cc4c4e1b443
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-01-24T12:28:01.504890Z, end-time: 2023-01-24T12:28:03.919966Z, duration: 2, exit-code: 0
python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
Collecting sphinx==2.3.1
  Downloading Sphinx-2.3.1-py3-none-any.whl (2.7 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.7/2.7 MB 61.6 MB/s eta 0:00:00
Collecting breathe==4.14.1
  Downloading breathe-4.14.1-py3-none-any.whl (74 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 74.7/74.7 kB 188.9 MB/s eta 0:00:00
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (58.2.0)
Collecting sphinxcontrib-applehelp
  Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 kB 219.8 MB/s eta 0:00:00
Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (23.0)
Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (1.4.1)
Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (3.0.3)
Requirement already satisfied: babel!=2.0,>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (2.11.0)
Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (2.2.0)
Collecting sphinxcontrib-devhelp
  Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 kB 191.9 MB/s eta 0:00:00
Collecting sphinxcontrib-jsmath
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (2.28.2)
Requirement already satisfied: sphinxcontrib-serializinghtml in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (1.1.5)
Collecting sphinxcontrib-htmlhelp
  Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 kB 204.6 MB/s eta 0:00:00
Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (0.7.13)
Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (2.14.0)
Collecting sphinxcontrib-qthelp
  Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 200.0 MB/s eta 0:00:00
Requirement already satisfied: docutils>=0.12 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) (0.17.1)
Requirement already satisfied: six>=1.9 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from breathe==4.14.1->-r docs/requirements.txt (line 5)) (1.16.0)
Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from babel!=2.0,>=1.3->sphinx==2.3.1->-r docs/requirements.txt (line 4)) (2022.7.1)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx==2.3.1->-r docs/requirements.txt (line 4)) (2.1.2)
Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx==2.3.1->-r docs/requirements.txt (line 4)) (1.26.14)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx==2.3.1->-r docs/requirements.txt (line 4)) (3.4)
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx==2.3.1->-r docs/requirements.txt (line 4)) (2022.12.7)
Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx==2.3.1->-r docs/requirements.txt (line 4)) (3.0.1)
Installing collected packages: sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, sphinx, breathe
  Attempting uninstall: sphinx
    Found existing installation: Sphinx 1.8.6
    Uninstalling Sphinx-1.8.6:
      Successfully uninstalled Sphinx-1.8.6
Successfully installed breathe-4.14.1 sphinx-2.3.1 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3

[rtd-command-info] start-time: 2023-01-24T12:28:05.662315Z, end-time: 2023-01-24T12:28:05.716254Z, duration: 0, exit-code: 0
cat docs/conf.py
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# 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('.'))
sys.path.append(os.path.abspath('../cli/'))
autodoc_mock_imports = ["pathlib", "cryptography", "nvs_partition_gen", "oauth2client", "serial", "user_mapping", "rmaker_tools.rmaker_prov.esp_rainmaker_prov", "rmaker_tools.rmaker_prov.security", "rmaker_tools.rmaker_prov.prov", "rmaker_tools.rmaker_prov.prov_util", "rmaker_tools.rmaker_claim.claim"]


# -- Project information -----------------------------------------------------

project = u'ESP RainMaker Programming Guide'
copyright = u'2020, Espressif Systems (Shanghai) CO., LTD'
author = 'Espressif'

try:
    builddir = os.environ['BUILDDIR']
except KeyError:
    builddir = '_build'

def call_with_python(cmd):
    # using sys.executable ensures that the scripts are called with the same Python interpreter
    if os.system('{} {}'.format(sys.executable, cmd)) != 0:
        raise RuntimeError('{} failed'.format(cmd))


# Call Doxygen to get XML files from the header files
print("Calling Doxygen to generate latest XML files")
if os.system("doxygen Doxyfile") != 0:
    raise RuntimeError('Doxygen call failed')

# Generate 'api_name.inc' files using the XML files by Doxygen
call_with_python('./gen-dxd.py')
# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'breathe',
    'sphinx.ext.autodoc',
    'link-roles'
]

# Setup the breathe extension
breathe_projects = {
    "ESP RainMaker": "./xml"
}
breathe_default_project = "ESP RainMaker"

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


# -- 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 = 'sphinx_rtd_theme'

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

html_logo = "_static/esp-rainmaker-logo.png"

def setup(app):
    app.add_stylesheet('theme_overrides.css')




###########################################################################
#          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:
    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",
    'proxied_static_path': "/_/static/",
    'versions': [
    ("latest", "/en/latest/"),
    ],
    'downloads': [ 
    ("pdf", "//espressif-docs.readthedocs-hosted.com/_/downloads/esp-rainmaker/en/latest/pdf/"),
    ("html", "//espressif-docs.readthedocs-hosted.com/_/downloads/esp-rainmaker/en/latest/htmlzip/"),
    ],
    'subprojects': [ 
    ],
    'slug': 'espressif-esp-rainmaker',
    'name': u'esp-rainmaker',
    'rtd_language': u'en',
    'programming_language': u'c',
    'canonical_url': 'https://espressif-docs.readthedocs-hosted.com/projects/esp-rainmaker/en/latest/',
    'analytics_code': 'None',
    'single_version': False,
    'conf_py_path': '/docs/',
    'api_host': 'https://readthedocs.com',
    'github_user': 'espressif',
    'proxied_api_host': '/_',
    'github_repo': 'esp-rainmaker',
    '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': '',
    'global_analytics_code': 'UA-17997319-2',
    'commit': 'f502deee',
}

# 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/espressif-esp-rainmaker/builds/1266646/'

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