Read the Docs build information Build id: 1478708 Project: espressif-esp-rainmaker Version: latest Commit: c0da2374b570cf992cac16e5c5cb2e3ca1251829 Date: 2023-05-17T11:32:25.367062Z State: finished Success: True [rtd-command-info] start-time: 2023-05-17T11:32:27.262859Z, end-time: 2023-05-17T11:32:28.676757Z, 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.112' (ECDSA) to the list of known hosts. [rtd-command-info] start-time: 2023-05-17T11:32:28.900731Z, end-time: 2023-05-17T11:32:28.991607Z, 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 Or undo this operation with: git switch - Turn off this advice by setting config variable advice.detachedHead to false HEAD is now at c0da237 Merge branch 'feature/optimize_local_ctrl_task_size' into 'master' [rtd-command-info] start-time: 2023-05-17T11:32:29.207878Z, end-time: 2023-05-17T11:32:29.298618Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2023-05-17T11:32:29.514445Z, end-time: 2023-05-17T11:32:29.612124Z, duration: 0, exit-code: 0 git submodule sync [rtd-command-info] start-time: 2023-05-17T11:32:29.860874Z, end-time: 2023-05-17T11:32:34.482655Z, 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.112' (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.112' (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.112' (ECDSA) to the list of known hosts. Submodule path 'cli': checked out '01add85ea880471ce3892c94ccb417e4364e0d34' Submodule path 'components/esp-insights': checked out '203a87f671710295579404f7d4c62a8a5e25ae7c' 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 '27556e17239523e9f3a5c6b472d0fcbfc38b394c' [rtd-command-info] start-time: 2023-05-17T11:32:35.582354Z, end-time: 2023-05-17T11:32:40.287191Z, 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/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-05-17T11:32:40.495313Z, end-time: 2023-05-17T11:32:41.674662Z, duration: 1, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (23.1.2) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages (67.7.2) [rtd-command-info] start-time: 2023-05-17T11:32:41.870049Z, end-time: 2023-05-17T11:32:48.654989Z, 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 44.7 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 232.7 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 180.9 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 194.5 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 194.5 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.0 MB/s eta 0:00:00 Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.20.1-py3-none-any.whl (572 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 231.2 MB/s eta 0:00:00 Collecting six>=1.5 (from sphinx<2) Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting Pygments>=2.0 (from sphinx<2) Downloading Pygments-2.15.1-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 232.8 MB/s eta 0:00:00 Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 223.2 MB/s eta 0:00:00 Collecting snowballstemmer>=1.1 (from sphinx<2) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 195.3 MB/s eta 0:00:00 Collecting babel!=2.0,>=1.3 (from sphinx<2) Downloading Babel-2.12.1-py3-none-any.whl (10.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.1/10.1 MB 195.5 MB/s eta 0:00:00 Collecting imagesize (from sphinx<2) Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting requests>=2.0.0 (from sphinx<2) Downloading requests-2.30.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.5/62.5 kB 160.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) (67.7.2) Collecting packaging (from sphinx<2) Downloading packaging-23.1-py3-none-any.whl (48 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 48.9/48.9 kB 177.0 MB/s eta 0:00:00 Collecting sphinxcontrib-websupport (from sphinx<2) Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting MarkupSafe>=2.0 (from jinja2<3.1.0) Downloading MarkupSafe-2.1.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting pytz>=2015.7 (from babel!=2.0,>=1.3->sphinx<2) Downloading pytz-2023.3-py2.py3-none-any.whl (502 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 502.3/502.3 kB 221.9 MB/s eta 0:00:00 Collecting charset-normalizer<4,>=2 (from requests>=2.0.0->sphinx<2) Downloading charset_normalizer-3.1.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (171 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 171.0/171.0 kB 209.8 MB/s eta 0:00:00 Collecting idna<4,>=2.5 (from requests>=2.0.0->sphinx<2) Downloading idna-3.4-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 174.6 MB/s eta 0:00:00 Collecting urllib3<3,>=1.21.1 (from requests>=2.0.0->sphinx<2) Downloading urllib3-2.0.2-py3-none-any.whl (123 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 123.2/123.2 kB 201.2 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 (from requests>=2.0.0->sphinx<2) Downloading certifi-2023.5.7-py3-none-any.whl (156 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 157.0/157.0 kB 201.4 MB/s eta 0:00:00 Collecting sphinxcontrib-serializinghtml (from sphinxcontrib-websupport->sphinx<2) Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 198.2 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=23753 sha256=41d0ccaccaf0d7e65ec857203f80925f0fb86bac3e035d6311bbf4f4ee9dd589 Stored in directory: /tmp/pip-ephem-wheel-cache-s993lgwm/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Successfully built mock Installing collected packages: snowballstemmer, pytz, mock, commonmark, urllib3, sphinxcontrib-serializinghtml, six, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, sphinxcontrib-websupport, requests, jinja2, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Successfully installed MarkupSafe-2.1.2 Pygments-2.15.1 alabaster-0.7.13 babel-2.12.1 certifi-2023.5.7 charset-normalizer-3.1.0 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.1 pillow-5.4.1 pytz-2023.3 readthedocs-sphinx-ext-2.2.0 recommonmark-0.5.0 requests-2.30.0 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-2.0.2 [rtd-command-info] start-time: 2023-05-17T11:32:48.903089Z, end-time: 2023-05-17T11:32:51.391050Z, duration: 2, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt Collecting sphinx==2.3.1 (from -r docs/requirements.txt (line 4)) Downloading Sphinx-2.3.1-py3-none-any.whl (2.7 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.7/2.7 MB 50.3 MB/s eta 0:00:00 Collecting breathe==4.14.1 (from -r docs/requirements.txt (line 5)) Downloading breathe-4.14.1-py3-none-any.whl (74 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 74.7/74.7 kB 166.2 MB/s eta 0:00:00 Collecting sphinxcontrib-applehelp (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 kB 195.1 MB/s eta 0:00:00 Collecting sphinxcontrib-devhelp (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 kB 185.8 MB/s eta 0:00:00 Collecting sphinxcontrib-jsmath (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-htmlhelp (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 kB 200.0 MB/s eta 0:00:00 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-qthelp (from sphinx==2.3.1->-r docs/requirements.txt (line 4)) Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 202.6 MB/s eta 0:00:00 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: 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.15.1) 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: 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) 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.12.1) 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: 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: 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.30.0) 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)) (67.7.2) 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.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)) (2023.3) 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: 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.1.0) 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: urllib3<3,>=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)) (2.0.2) 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)) (2023.5.7) 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-05-17T11:32:53.119165Z, end-time: 2023-05-17T11:32:53.197368Z, 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: 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/"), ], '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': 'c0da2374', } # 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/1478708/' 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']) [rtd-command-info] start-time: 2023-05-17T11:32:53.431261Z, end-time: 2023-05-17T11:33:10.643850Z, duration: 17, exit-code: 0 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v2.3.1 Getting Doxyfile's INPUT Generating 'api_name.inc' files with Doxygen directives Calling Doxygen to generate latest XML files loading translations [en]... done fatal: No names found, cannot describe anything. Git commit ID: c0da237 making output directory... done building [mo]: targets for 0 po files that are out of date building [html]: targets for 11 source files that are out of date updating environment: [new config] 11 added, 0 changed, 0 removed reading sources... [ 9%] c-api-reference/index reading sources... [ 18%] c-api-reference/rainmaker_common reading sources... [ 27%] c-api-reference/rainmaker_console reading sources... [ 36%] c-api-reference/rainmaker_core reading sources... [ 45%] c-api-reference/rainmaker_mqtt reading sources... [ 54%] c-api-reference/rainmaker_ota reading sources... [ 63%] c-api-reference/rainmaker_standard_types reading sources... [ 72%] index reading sources... [ 81%] python-api-reference/cmd reading sources... [ 90%] python-api-reference/index reading sources... [100%] python-api-reference/lib looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 9%] c-api-reference/index writing output... [ 18%] c-api-reference/rainmaker_common writing output... [ 27%] c-api-reference/rainmaker_console writing output... [ 36%] c-api-reference/rainmaker_core writing output... [ 45%] c-api-reference/rainmaker_mqtt writing output... [ 54%] c-api-reference/rainmaker_ota writing output... [ 63%] c-api-reference/rainmaker_standard_types writing output... [ 72%] index writing output... [ 81%] python-api-reference/cmd writing output... [ 90%] python-api-reference/index writing output... [100%] python-api-reference/lib generating indices... genindex py-modindexdone writing additional pages... searchdone copying static files... ... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done build succeeded. The HTML pages are in ../_readthedocs/html. Updating searchtools for Read the Docs search... /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages/sphinx/util/docutils.py:285: RemovedInSphinx30Warning: function based directive support is now deprecated. Use class based directive instead. RemovedInSphinx30Warning) /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-rainmaker/envs/latest/lib/python3.7/site-packages/sphinx_rtd_theme/search.html:21: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a