Read the Docs build information Build id: 193443 Project: espressif-esp-adf Version: latest Commit: 0c3139ea098463b6a2d2385aac2b8c5751a53864 Date: 2019-03-20T18:48:12.162938Z State: finished Success: False [rtd-command-info] start-time: 2019-03-20T18:48:16.942659Z, end-time: 2019-03-20T18:48:16.955356Z, duration: 0, exit-code: 0 git remote set-url origin git@github.com:espressif/esp-adf.git [rtd-command-info] start-time: 2019-03-20T18:48:17.016895Z, end-time: 2019-03-20T18:48:17.743271Z, duration: 0, exit-code: 0 git fetch --tags --prune --prune-tags --depth 50 From github.com:espressif/esp-adf 56423c8..0c3139e master -> origin/master [rtd-command-info] start-time: 2019-03-20T18:48:17.943356Z, end-time: 2019-03-20T18:48:18.243692Z, duration: 0, exit-code: 0 git checkout --force origin/master Previous HEAD position was 56423c8 Merge branch 'feature/display_service' into 'master' HEAD is now at 0c3139e Merge branch 'featrue/board_compatibility_docs' into 'master' [rtd-command-info] start-time: 2019-03-20T18:48:18.314477Z, end-time: 2019-03-20T18:48:18.330781Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2019-03-20T18:48:18.599428Z, end-time: 2019-03-20T18:48:18.626758Z, duration: 0, exit-code: 0 git submodule sync Synchronizing submodule url for 'components/esp-adf-libs' Synchronizing submodule url for 'esp-idf' [rtd-command-info] start-time: 2019-03-20T18:48:18.687400Z, end-time: 2019-03-20T18:48:45.054704Z, duration: 26, exit-code: 0 git submodule update --init --force --recursive esp-idf components/esp-adf-libs Submodule path 'components/esp-adf-libs': checked out '61c60ffbafb69f3651906dd264955489df1bdc58' Submodule path 'esp-idf': checked out '2aa9a21180e5320e195df6cd4ea130f9ea6f27a1' Submodule path 'esp-idf/components/aws_iot/aws-iot-device-sdk-embedded-C': checked out '8bf852db77c360eebfa4b800754fdb90e29ea43e' Submodule path 'esp-idf/components/bt/lib': checked out '3de0bcb653dfd734004949f72b696099d149e983' Submodule path 'esp-idf/components/coap/libcoap': checked out '6468887a12666f88b8704d797fc176cd4f40ee4c' Submodule path 'esp-idf/components/esp32/lib': checked out '1eed344adc0bb1240a0d66dc7811f78f9a77de4f' Submodule path 'esp-idf/components/esptool_py/esptool': checked out '9fbe1eec656dc69942f5163cc6cc79c33d5aad64' Submodule path 'esp-idf/components/json/cJSON': checked out '7cc52f60356909b3dd260304c7c50c0693699353' Submodule path 'esp-idf/components/libsodium/libsodium': checked out '70170c28c844a4786e75efc626e1aeebc93caebc' Submodule path 'esp-idf/components/mbedtls/mbedtls': checked out 'b9ada3067587aaccb37c33d41733bb82496c6342' Submodule path 'esp-idf/components/micro-ecc/micro-ecc': checked out 'd037ec89546fad14b5c4d5456c2e23a71e554966' Submodule path 'esp-idf/components/nghttp/nghttp2': checked out '3bcc416e13cc790e2fb45fcfe9111d38609c5032' Submodule path 'esp-idf/components/nghttp/nghttp2/third-party/mruby': checked out '22464fe5a0a10f2b077eaba109ce1e912e4a77de' Submodule path 'esp-idf/components/nghttp/nghttp2/third-party/neverbleed': checked out 'da5c2ab419a3bb8a4cc6c37a6c7f3e4bd4b41134' Submodule path 'esp-idf/components/spiffs/spiffs': checked out 'f5e26c4e933189593a71c6b82cda381a7b21e41c' [rtd-command-info] start-time: 2019-03-20T18:48:45.872827Z, end-time: 2019-03-20T18:48:49.188763Z, duration: 3, exit-code: 0 python2.7 -mvirtualenv --no-site-packages --no-download New python executable in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/bin/python2.7 Not overwriting existing python script /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/bin/python (you must use /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/bin/python2.7) Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2019-03-20T18:48:49.251870Z, end-time: 2019-03-20T18:48:49.902383Z, duration: 0, exit-code: 0 python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/.cache/pip pip Requirement already up-to-date: pip in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (19.0.3) [rtd-command-info] start-time: 2019-03-20T18:48:49.962906Z, end-time: 2019-03-20T18:48:52.260610Z, duration: 2, exit-code: 0 python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/.cache/pip Pygments==2.2.0 setuptools<40 docutils==0.13.1 mock==1.0.1 pillow==2.6.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.5.4 recommonmark==0.4.0 sphinx<1.8 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<0.6 Requirement already up-to-date: Pygments==2.2.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (2.2.0) Collecting setuptools<40 Using cached https://files.pythonhosted.org/packages/7f/e1/820d941153923aac1d49d7fc37e17b6e73bfbd2904959fffbad77900cf92/setuptools-39.2.0-py2.py3-none-any.whl Requirement already up-to-date: docutils==0.13.1 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (0.13.1) Requirement already up-to-date: mock==1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (1.0.1) Requirement already up-to-date: pillow==2.6.1 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (2.6.1) Requirement already up-to-date: alabaster!=0.7.5,<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (0.7.12) Requirement already up-to-date: commonmark==0.5.4 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (0.5.4) Requirement already up-to-date: recommonmark==0.4.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (0.4.0) Requirement already up-to-date: sphinx<1.8 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (1.7.9) Requirement already up-to-date: sphinx-rtd-theme<0.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (0.4.3) Requirement already up-to-date: readthedocs-sphinx-ext<0.6 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (0.5.17) Requirement already satisfied, skipping upgrade: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx<1.8) (1.2.1) Requirement already satisfied, skipping upgrade: sphinxcontrib-websupport in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx<1.8) (1.1.0) Requirement already satisfied, skipping upgrade: babel!=2.0,>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx<1.8) (2.6.0) Requirement already satisfied, skipping upgrade: requests>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx<1.8) (2.21.0) Requirement already satisfied, skipping upgrade: packaging in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx<1.8) (19.0) Requirement already satisfied, skipping upgrade: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx<1.8) (2.10) Requirement already satisfied, skipping upgrade: typing; python_version < "3.5" in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx<1.8) (3.6.6) Requirement already satisfied, skipping upgrade: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx<1.8) (1.1.0) Requirement already satisfied, skipping upgrade: six>=1.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx<1.8) (1.12.0) Requirement already satisfied, skipping upgrade: pytz>=0a in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from babel!=2.0,>=1.3->sphinx<1.8) (2018.9) Requirement already satisfied, skipping upgrade: urllib3<1.25,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx<1.8) (1.24.1) Requirement already satisfied, skipping upgrade: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx<1.8) (2019.3.9) Requirement already satisfied, skipping upgrade: chardet<3.1.0,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx<1.8) (3.0.4) Requirement already satisfied, skipping upgrade: idna<2.9,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx<1.8) (2.8) Requirement already satisfied, skipping upgrade: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from packaging->sphinx<1.8) (2.3.1) Requirement already satisfied, skipping upgrade: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from Jinja2>=2.3->sphinx<1.8) (1.1.1) Installing collected packages: setuptools Found existing installation: setuptools 40.6.3 Uninstalling setuptools-40.6.3: Successfully uninstalled setuptools-40.6.3 Successfully installed setuptools-39.2.0 [rtd-command-info] start-time: 2019-03-20T18:48:52.326830Z, end-time: 2019-03-20T18:48:52.917827Z, duration: 0, exit-code: 0 python -m pip install --exists-action=w --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/.cache/pip -r docs/requirements.txt Requirement already satisfied: sphinx>=1.6.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from -r docs/requirements.txt (line 4)) (1.7.9) Requirement already satisfied: sphinx-rtd-theme in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from -r docs/requirements.txt (line 5)) (0.4.3) Requirement already satisfied: breathe>=4.7.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from -r docs/requirements.txt (line 6)) (4.12.0) Requirement already satisfied: sphinxcontrib-blockdiag>=1.5.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from -r docs/requirements.txt (line 7)) (1.5.5) Requirement already satisfied: sphinxcontrib-seqdiag>=0.8.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from -r docs/requirements.txt (line 8)) (0.8.5) Requirement already satisfied: sphinxcontrib-actdiag>=0.8.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from -r docs/requirements.txt (line 9)) (0.8.5) Requirement already satisfied: sphinxcontrib-nwdiag>=0.9.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from -r docs/requirements.txt (line 10)) (0.9.5) Requirement already satisfied: recommonmark in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from -r docs/requirements.txt (line 11)) (0.4.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (0.7.12) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (1.2.1) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (2.2.0) Requirement already satisfied: sphinxcontrib-websupport in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (1.1.0) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (19.0) Requirement already satisfied: babel!=2.0,>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (2.6.0) Requirement already satisfied: requests>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (2.21.0) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (39.2.0) Requirement already satisfied: docutils>=0.11 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (0.13.1) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (2.10) Requirement already satisfied: typing; python_version < "3.5" in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (3.6.6) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (1.1.0) Requirement already satisfied: six>=1.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (1.12.0) Requirement already satisfied: blockdiag>=1.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinxcontrib-blockdiag>=1.5.3->-r docs/requirements.txt (line 7)) (1.5.4) Requirement already satisfied: seqdiag>=0.9.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinxcontrib-seqdiag>=0.8.5->-r docs/requirements.txt (line 8)) (0.9.6) Requirement already satisfied: actdiag>=0.5.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinxcontrib-actdiag>=0.8.5->-r docs/requirements.txt (line 9)) (0.5.4) Requirement already satisfied: nwdiag>=1.0.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from sphinxcontrib-nwdiag>=0.9.5->-r docs/requirements.txt (line 10)) (1.0.4) Requirement already satisfied: commonmark<=0.5.4 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from recommonmark->-r docs/requirements.txt (line 11)) (0.5.4) Requirement already satisfied: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from packaging->sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (2.3.1) Requirement already satisfied: pytz>=0a in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from babel!=2.0,>=1.3->sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (2018.9) Requirement already satisfied: urllib3<1.25,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (1.24.1) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (2019.3.9) Requirement already satisfied: chardet<3.1.0,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (3.0.4) Requirement already satisfied: idna<2.9,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from requests>=2.0.0->sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (2.8) Requirement already satisfied: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from Jinja2>=2.3->sphinx>=1.6.5->-r docs/requirements.txt (line 4)) (1.1.1) Requirement already satisfied: webcolors in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from blockdiag>=1.5.0->sphinxcontrib-blockdiag>=1.5.3->-r docs/requirements.txt (line 7)) (1.8.1) Requirement already satisfied: Pillow in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from blockdiag>=1.5.0->sphinxcontrib-blockdiag>=1.5.3->-r docs/requirements.txt (line 7)) (2.6.1) Requirement already satisfied: funcparserlib in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages (from blockdiag>=1.5.0->sphinxcontrib-blockdiag>=1.5.3->-r docs/requirements.txt (line 7)) (0.3.6) [rtd-command-info] start-time: 2019-03-20T18:48:53.520592Z, end-time: 2019-03-20T18:48:53.580998Z, duration: 0, exit-code: 0 cat docs/en/conf.py # -*- coding: utf-8 -*- # # Read the Docs Template documentation build configuration file, created by # sphinx-quickstart on Tue Aug 26 14:19:49 2014. # # 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. import sys, os import re from subprocess import Popen, PIPE import shlex # 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. sys.path.insert(0, os.path.abspath('..')) from local_util import run_cmd_get_output, copy_if_modified builddir = '_build' if 'BUILDDIR' in os.environ: builddir = os.environ['BUILDDIR'] # Call Doxygen to get XML files from the header files print "Calling Doxygen to generate latest XML files" os.system("doxygen ../Doxyfile") # Doxygen has generated XML files in 'xml' directory. # Copy them to 'xml_in', only touching the files which have changed. copy_if_modified('xml/', 'xml_in/') # Generate 'api_name.inc' files using the XML files by Doxygen os.system('python ../gen-dxd.py') # Generate 'kconfig.inc' file from components' Kconfig files kconfig_inc_path = '{}/inc/kconfig.inc'.format(builddir) os.system('python ../gen-kconfig-doc.py > ' + kconfig_inc_path + '.in') copy_if_modified(kconfig_inc_path + '.in', kconfig_inc_path) # http://stackoverflow.com/questions/12772927/specifying-an-online-image-in-sphinx-restructuredtext-format # suppress_warnings = ['image.nonlocal_uri'] # -- 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 = ['breathe', 'link-roles', 'sphinxcontrib.blockdiag', 'sphinxcontrib.seqdiag', 'sphinxcontrib.actdiag', 'sphinxcontrib.nwdiag', 'sphinxcontrib.rackdiag', 'sphinxcontrib.packetdiag' ] # Set up font for blockdiag, nwdiag, rackdiag and packetdiag blockdiag_fontpath = '../_static/DejaVuSans.ttf' seqdiag_fontpath = '../_static/DejaVuSans.ttf' actdiag_fontpath = '../_static/DejaVuSans.ttf' nwdiag_fontpath = '../_static/DejaVuSans.ttf' rackdiag_fontpath = '../_static/DejaVuSans.ttf' packetdiag_fontpath = '../_static/DejaVuSans.ttf' # Breathe extension variables # Doxygen regenerates files in 'xml/' directory every time, # but we copy files to 'xml_in/' only when they change, to speed up # incremental builds. breathe_projects = { "esp32-adf": "xml_in/" } breathe_default_project = "esp32-adf" # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = ['.rst', '.md'] source_parsers = { '.md': 'recommonmark.parser.CommonMarkParser', } # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'Audio Development Framework' copyright = u'2017 - 2018, Espressif' # 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. # # Readthedocs largely ignores 'version' and 'release', and displays one of # 'latest', tag name, or branch name, depending on the build type. # Still, this is useful for non-RTD builds. # This is supposed to be "the short X.Y version", but it's the only version # visible when you open index.html. # Display full version to make things less confusing. version = run_cmd_get_output('git describe') # The full version, including alpha/beta/rc tags. # If needed, nearest tag is returned by 'git describe --abbrev=0'. release = version print 'Version: {0} Release: {1}'.format(version, release) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build','README.md'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = 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 = 'sphinx_rtd_theme' # 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 = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. html_logo = "../_static/espressif-logo.svg" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # 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'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'ReadtheDocsTemplatedoc' # -- 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': '', } # 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 = [ ('index', 'ReadtheDocsTemplate.tex', u'Read the Docs Template Documentation', u'Read the Docs', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'readthedocstemplate', u'Read the Docs Template Documentation', [u'Read the Docs'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- 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 = [ ('index', 'ReadtheDocsTemplate', u'Read the Docs Template Documentation', u'Read the Docs', 'ReadtheDocsTemplate', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # Override RTD CSS theme to introduce the theme corrections # https://github.com/rtfd/sphinx_rtd_theme/pull/432 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/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 mulitple 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://media.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://media.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'versions': [ ("latest", "/en/latest/"), ("stable", "/en/stable/"), ("v1.0", "/en/v1.0/"), ], 'downloads': [ ("pdf", "//readthedocs.com/projects/espressif-esp-adf/downloads/pdf/latest/"), ("htmlzip", "//readthedocs.com/projects/espressif-esp-adf/downloads/htmlzip/latest/"), ], 'subprojects': [ ], 'slug': 'espressif-esp-adf', 'name': u'esp-adf', 'rtd_language': u'en', 'programming_language': u'c', 'canonical_url': 'https://docs.espressif.com/projects/esp-adf/en/latest/', 'analytics_code': 'UA-132861133-1', 'single_version': False, 'conf_py_path': '/docs/en/', 'api_host': 'https://readthedocs.com', 'github_user': 'espressif', 'github_repo': 'esp-adf', '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, 'user_analytics_code': 'UA-132861133-1', 'global_analytics_code': 'UA-17997319-2', 'commit': '0c3139ea', } 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"] [rtd-command-info] start-time: 2019-03-20T18:48:53.647046Z, end-time: 2019-03-20T18:48:58.587682Z, duration: 4, exit-code: 2 python sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v1.7.9 Getting Doxyfile's INPUT Generating 'api_name.inc' files with Doxygen directives fatal: No annotated tags can describe '0c3139ea098463b6a2d2385aac2b8c5751a53864'. However, there were unannotated tags: try --tags. Calling Doxygen to generate latest XML files Version: Release: loading translations [en]... done Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages/sphinx/cmdline.py", line 303, in main args.warningiserror, args.tags, args.verbosity, args.jobs) File "/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages/sphinx/application.py", line 191, in __init__ self.setup_extension(extension) File "/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages/sphinx/application.py", line 411, in setup_extension self.registry.load_extension(self, extname) File "/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages/sphinx/registry.py", line 326, in load_extension metadata = mod.setup(app) File "/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages/breathe/__init__.py", line 13, in setup from . import directives File "/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages/breathe/directives.py", line 4, in from .renderer import DoxygenToRstRendererFactory File "/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages/breathe/renderer/__init__.py", line 5, in from . import sphinxrenderer File "/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages/breathe/renderer/sphinxrenderer.py", line 67, in class DomainDirectiveFactory(object): File "/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages/breathe/renderer/sphinxrenderer.py", line 80, in DomainDirectiveFactory 'union': (cpp.CPPUnionObject, 'union'), AttributeError: 'module' object has no attribute 'CPPUnionObject' Exception occurred: File "/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-adf/envs/latest/lib/python2.7/site-packages/breathe/renderer/sphinxrenderer.py", line 80, in DomainDirectiveFactory 'union': (cpp.CPPUnionObject, 'union'), AttributeError: 'module' object has no attribute 'CPPUnionObject' The full traceback has been saved in /tmp/sphinx-err-lcD2Lr.log, if you want to report the issue to the developers. Please also report this if it was a user error, so that a better error message can be provided next time. A bug report can be filed in the tracker at . Thanks!