Read the Docs build information Build id: 580585 Project: espressif-esp-idf-zh-cn Version: release-v3.3 Commit: c8915cd1578b26b33854f14cc5f75cf1766ed021 Date: 2021-03-04T23:46:08.716654Z State: finished Success: False [rtd-command-info] start-time: 2021-03-04T23:46:10.238202Z, end-time: 2021-03-04T23:46:23.886198Z, duration: 13, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/espressif/esp-idf.git . Cloning into '.'... [rtd-command-info] start-time: 2021-03-04T23:46:24.225464Z, end-time: 2021-03-04T23:46:25.097098Z, duration: 0, exit-code: 0 git checkout --force origin/release/v3.3 Note: checking out 'origin/release/v3.3'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at c8915cd15 Merge branch 'bugfix/fix_spp_can_not_connect_twice' into 'release/v3.3' [rtd-command-info] start-time: 2021-03-04T23:46:25.215074Z, end-time: 2021-03-04T23:46:25.287166Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-03-04T23:46:25.667841Z, end-time: 2021-03-04T23:46:26.125135Z, duration: 0, exit-code: 0 git submodule sync [rtd-command-info] start-time: 2021-03-04T23:46:26.244980Z, end-time: 2021-03-04T23:46:26.883446Z, duration: 0, exit-code: 0 git submodule update --init --force components/mqtt/esp-mqtt Submodule 'components/mqtt/esp-mqtt' (https://github.com/espressif/esp-mqtt.git) registered for path 'components/mqtt/esp-mqtt' Cloning into '/home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/checkouts/release-v3.3/components/mqtt/esp-mqtt'... Submodule path 'components/mqtt/esp-mqtt': checked out 'da850b0add1e71b3659bfac5d797cc834dc3e89b' [rtd-command-info] start-time: 2021-03-04T23:46:28.108984Z, end-time: 2021-03-04T23:46:31.944222Z, duration: 3, exit-code: 0 python2.7 -mvirtualenv New python executable in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/bin/python2.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2021-03-04T23:46:32.070797Z, end-time: 2021-03-04T23:46:33.723481Z, duration: 1, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools==41.0.1 DEPRECATION: Python 2.7 reached the end of its life on January 1st, 2020. Please upgrade your Python as Python 2.7 is no longer maintained. pip 21.0 will drop support for Python 2.7 in January 2021. More details about Python 2 support in pip can be found at https://pip.pypa.io/en/latest/development/release-process/#python-2-support pip 21.0 will remove support for this functionality. Requirement already up-to-date: pip in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (20.3.4) Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) Installing collected packages: setuptools Attempting uninstall: setuptools Found existing installation: setuptools 44.1.1 Uninstalling setuptools-44.1.1: Successfully uninstalled setuptools-44.1.1 Successfully installed setuptools-41.0.1 [rtd-command-info] start-time: 2021-03-04T23:46:33.839075Z, end-time: 2021-03-04T23:46:42.591212Z, duration: 8, exit-code: 0 python -m pip install --upgrade --no-cache-dir docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.2 DEPRECATION: Python 2.7 reached the end of its life on January 1st, 2020. Please upgrade your Python as Python 2.7 is no longer maintained. pip 21.0 will drop support for Python 2.7 in January 2021. More details about Python 2 support in pip can be found at https://pip.pypa.io/en/latest/development/release-process/#python-2-support pip 21.0 will remove support for this functionality. Collecting docutils==0.14 Downloading docutils-0.14-py2-none-any.whl (543 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.tar.gz (818 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp27-cp27mu-manylinux1_x86_64.whl (2.0 MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx<2 Downloading Sphinx-1.8.5-py2.py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) Collecting readthedocs-sphinx-ext<2.2 Downloading readthedocs_sphinx_ext-2.1.3-py2.py3-none-any.whl (11 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting typing; python_version < "3.5" Downloading typing-3.7.4.3-py2-none-any.whl (26 kB) Collecting Pygments>=2.0 Downloading Pygments-2.5.2-py2.py3-none-any.whl (896 kB) Collecting Jinja2>=2.3 Downloading Jinja2-2.11.3-py2.py3-none-any.whl (125 kB) Collecting packaging Downloading packaging-20.9-py2.py3-none-any.whl (40 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.1.0-py2.py3-none-any.whl (93 kB) Requirement already satisfied, skipping upgrade: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx<2) (41.0.1) Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.0-py2.py3-none-any.whl (8.8 MB) Collecting six>=1.5 Downloading six-1.15.0-py2.py3-none-any.whl (10 kB) Collecting requests>=2.0.0 Downloading requests-2.25.1-py2.py3-none-any.whl (61 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.1.2-py2.py3-none-any.whl (39 kB) Collecting MarkupSafe>=0.23 Downloading MarkupSafe-1.1.1-cp27-cp27mu-manylinux1_x86_64.whl (24 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting pytz>=2015.7 Downloading pytz-2021.1-py2.py3-none-any.whl (510 kB) Collecting chardet<5,>=3.0.2 Downloading chardet-4.0.0-py2.py3-none-any.whl (178 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.3-py2.py3-none-any.whl (137 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting certifi>=2017.4.17 Downloading certifi-2020.12.5-py2.py3-none-any.whl (147 kB) Building wheels for collected packages: mock, future Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-py2-none-any.whl size=23756 sha256=315f297cbfaca32d8df4f9b967c4be7ba92c0d7a633c8fde9071038f2ffa99b0 Stored in directory: /tmp/pip-ephem-wheel-cache-CIAEjQ/wheels/ad/62/e0/a06cc957652749e64c7904e899eca3ecb2ec47c60d52653660 Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py2-none-any.whl size=502566 sha256=9ee9e1c2e2dfba713a49dba428cbc42ca7895138833b283d2b0ebdf57fda6468 Stored in directory: /tmp/pip-ephem-wheel-cache-CIAEjQ/wheels/5f/11/0c/aad680baf5ef4fbcbab992c9f03e1130357e0c173a4fdabfff Successfully built mock future Installing collected packages: docutils, mock, pillow, alabaster, future, commonmark, imagesize, typing, Pygments, MarkupSafe, Jinja2, pyparsing, packaging, snowballstemmer, pytz, babel, six, chardet, urllib3, idna, certifi, requests, sphinxcontrib-websupport, sphinx, recommonmark, sphinx-rtd-theme, readthedocs-sphinx-ext Successfully installed Jinja2-2.11.3 MarkupSafe-1.1.1 Pygments-2.5.2 alabaster-0.7.12 babel-2.9.0 certifi-2020.12.5 chardet-4.0.0 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.9 pillow-5.4.1 pyparsing-2.4.7 pytz-2021.1 readthedocs-sphinx-ext-2.1.3 recommonmark-0.5.0 requests-2.25.1 six-1.15.0 snowballstemmer-2.1.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-websupport-1.1.2 typing-3.7.4.3 urllib3-1.26.3 [rtd-command-info] start-time: 2021-03-04T23:46:42.707306Z, end-time: 2021-03-04T23:46:46.177502Z, duration: 3, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt DEPRECATION: Python 2.7 reached the end of its life on January 1st, 2020. Please upgrade your Python as Python 2.7 is no longer maintained. pip 21.0 will drop support for Python 2.7 in January 2021. More details about Python 2 support in pip can be found at https://pip.pypa.io/en/latest/development/release-process/#python-2-support pip 21.0 will remove support for this functionality. Requirement already satisfied: sphinx>=1.8.4 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from -r docs/requirements.txt (line 4)) (1.8.5) Collecting breathe==4.11.1 Downloading breathe-4.11.1-py2.py3-none-any.whl (74 kB) Requirement already satisfied: sphinx-rtd-theme in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from -r docs/requirements.txt (line 6)) (0.4.3) Collecting sphinxcontrib-blockdiag<2.0.0,>=1.5.5 Downloading sphinxcontrib_blockdiag-1.5.5-py2.py3-none-any.whl (7.0 kB) Collecting sphinxcontrib-seqdiag<2.0.0,>=0.8.5 Downloading sphinxcontrib_seqdiag-0.8.5-py2.py3-none-any.whl (7.0 kB) Collecting sphinxcontrib-actdiag<2.0.0,>=0.8.5 Downloading sphinxcontrib_actdiag-0.8.5-py2.py3-none-any.whl (7.0 kB) Collecting sphinxcontrib-nwdiag<2.0.0,>=0.9.5 Downloading sphinxcontrib_nwdiag-0.9.5-py2.py3-none-any.whl (13 kB) Collecting blockdiag<2.0.0,>=1.5.4 Downloading blockdiag-1.5.4-py2.py3-none-any.whl (2.7 MB) Collecting seqdiag<2.0.0,>=0.9.6 Downloading seqdiag-0.9.6-py2.py3-none-any.whl (2.6 MB) Collecting actdiag<2.0.0,>=0.5.4 Downloading actdiag-0.5.4-py2.py3-none-any.whl (2.6 MB) Collecting nwdiag<2.0.0,>=1.0.4 Downloading nwdiag-1.0.4-py2.py3-none-any.whl (7.7 MB) Requirement already satisfied: recommonmark in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from -r docs/requirements.txt (line 15)) (0.5.0) Requirement already satisfied: future>=0.16.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from -r docs/requirements.txt (line 16)) (0.18.2) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (1.2.0) Requirement already satisfied: typing; python_version < "3.5" in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (3.7.4.3) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (2.5.2) Requirement already satisfied: docutils>=0.11 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (0.14) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (2.11.3) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (20.9) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-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-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (2.1.0) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (41.0.1) Requirement already satisfied: babel!=2.0,>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (2.9.0) Requirement already satisfied: six>=1.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (1.15.0) Requirement already satisfied: requests>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (2.25.1) Requirement already satisfied: sphinxcontrib-websupport in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (1.1.2) Collecting funcparserlib Downloading funcparserlib-0.3.6.tar.gz (30 kB) Collecting webcolors Downloading webcolors-1.10-py2.py3-none-any.whl (10 kB) Requirement already satisfied: Pillow in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from blockdiag<2.0.0,>=1.5.4->-r docs/requirements.txt (line 11)) (5.4.1) Requirement already satisfied: commonmark>=0.7.3 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from recommonmark->-r docs/requirements.txt (line 15)) (0.8.1) Requirement already satisfied: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from Jinja2>=2.3->sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (1.1.1) Requirement already satisfied: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from packaging->sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (2.4.7) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from babel!=2.0,>=1.3->sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (2021.1) Requirement already satisfied: chardet<5,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from requests>=2.0.0->sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (4.0.0) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from requests>=2.0.0->sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (1.26.3) Requirement already satisfied: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from requests>=2.0.0->sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (2.10) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/espressif-esp-idf-zh-cn/envs/release-v3.3/lib/python2.7/site-packages (from requests>=2.0.0->sphinx>=1.8.4->-r docs/requirements.txt (line 4)) (2020.12.5) Building wheels for collected packages: funcparserlib Building wheel for funcparserlib (setup.py): started Building wheel for funcparserlib (setup.py): finished with status 'done' Created wheel for funcparserlib: filename=funcparserlib-0.3.6-py2-none-any.whl size=17488 sha256=be825c64deb7d73ddc5ae38b00dfc26c31fe752bd23b4ecbb5c959b5d43e31df Stored in directory: /tmp/pip-ephem-wheel-cache-srBFVQ/wheels/7b/df/d0/1da7d3e15517c32cef383541dae5007897b0806fcfb6586ec8 Successfully built funcparserlib Installing collected packages: breathe, funcparserlib, webcolors, blockdiag, sphinxcontrib-blockdiag, seqdiag, sphinxcontrib-seqdiag, actdiag, sphinxcontrib-actdiag, nwdiag, sphinxcontrib-nwdiag Successfully installed actdiag-0.5.4 blockdiag-1.5.4 breathe-4.11.1 funcparserlib-0.3.6 nwdiag-1.0.4 seqdiag-0.9.6 sphinxcontrib-actdiag-0.8.5 sphinxcontrib-blockdiag-1.5.5 sphinxcontrib-nwdiag-0.9.5 sphinxcontrib-seqdiag-0.8.5 webcolors-1.10 [rtd-command-info] start-time: 2021-03-04T23:46:47.651913Z, end-time: 2021-03-04T23:46:47.725373Z, duration: 0, exit-code: 0 cat docs/zh_CN/conf.py # -*- coding: utf-8 -*- # # English Language RTD & Sphinx config file # # Uses ../conf_common.py for most non-language-specific settings. # Importing conf_common adds all the non-language-specific # parts to this conf module try: from conf_common import * # noqa: F403,F401 except ImportError: import sys import os sys.path.insert(0, os.path.abspath('..')) from conf_common import * # noqa: F403,F401 # General information about the project. project = u'ESP-IDF 编程指南' copyright = u'2016 - 2020 乐鑫信息科技（上海）股份有限公司' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. language = 'zh_CN' ########################################################################### # 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 # # Note: this file should't rely on extra depencies. 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': "release/v3.3", 'version_slug': "release-v3.3", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'versions': [ ("latest", "/zh_CN/latest/"), ("stable", "/zh_CN/stable/"), ("v4.1", "/zh_CN/v4.1/"), ("v4.0.2", "/zh_CN/v4.0.2/"), ("v4.0.1", "/zh_CN/v4.0.1/"), ("v4.0", "/zh_CN/v4.0/"), ("v3.3.4", "/zh_CN/v3.3.4/"), ("v3.3.2", "/zh_CN/v3.3.2/"), ("v3.3.1", "/zh_CN/v3.3.1/"), ("v3.3", "/zh_CN/v3.3/"), ("v3.2.5", "/zh_CN/v3.2.5/"), ("v3.2.3", "/zh_CN/v3.2.3/"), ("v3.2.2", "/zh_CN/v3.2.2/"), ("v3.1.7", "/zh_CN/v3.1.7/"), ("v3.1.6", "/zh_CN/v3.1.6/"), ("v3.1.5", "/zh_CN/v3.1.5/"), ("release-v4.1", "/zh_CN/release-v4.1/"), ("release-v4.0", "/zh_CN/release-v4.0/"), ("release-v3.3", "/zh_CN/release-v3.3/"), ("release-v3.2", "/zh_CN/release-v3.2/"), ], 'downloads': [ ("pdf", "//docs.espressif.com/_/downloads/esp-idf/zh_CN/release-v3.3/pdf/"), ], 'subprojects': [ ], 'slug': 'espressif-esp-idf-zh-cn', 'name': u'esp-idf-zh_CN', 'rtd_language': u'zh_CN', 'programming_language': u'c', 'canonical_url': 'https://docs.espressif.com/projects/esp-idf/zh_CN/latest/', 'analytics_code': 'UA-132861133-1', 'single_version': False, 'conf_py_path': '/docs/zh_CN/', 'api_host': 'https://readthedocs.com', 'github_user': 'espressif', 'proxied_api_host': '/_', 'github_repo': 'esp-idf', 'github_version': 'release/v3.3', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'release/v3.3', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'release/v3.3', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'docsearch_disabled': False, 'user_analytics_code': 'UA-132861133-1', 'global_analytics_code': 'UA-17997319-2', 'commit': 'c8915cd1', } # 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-idf-zh-cn/builds/580585/' project_language = 'zh_CN' # 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'])