Головна сторінка Огляд Довідка
Увійти
RT-Thread-packages
/
esp-idf
дзеркало https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Відгалуження 0
Файли Проблеми 0 Wiki
Дерево: 6540877f23
Гілки Теги
esp-idf
/
docs
Wang Jia Lin f9d5b67b81 Merge branch 'refactor/hal_i2s_driver' into 'master' 6 роки тому
..
_static 0abb3b99c1 Update missing description of board A and B connectors. Add a note about incorrect GPIO pin labels on the silkscreen besides the function switch. 6 роки тому
en 1d06b6b07e Add information on compatibility issue between JTAG and AT firmware. 6 роки тому
zh_CN 29b2235506 Merge branch 'doc/mdns_zh_CN' into 'master' 6 роки тому
Doxyfile 8c76a3c10d refactor(i2s): add hal i2s driver 6 роки тому
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 роки тому
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 роки тому
check_doc_warnings.sh e1e8c36492 docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs. 7 роки тому
check_lang_folder_sync.sh 621076f329 Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files 8 роки тому
conf_common.py 84d5cc1c17 Generate source files for kconfiglib from the build system 6 роки тому
docs_common.mk 5db1f5fdfb docs: Add ESP-IDF support period policy 6 роки тому
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 роки тому
gen-toolchain-links.py c2db6a14c4 Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets 6 роки тому
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs 7 роки тому
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 роки тому
issue_template.md 9eeec5d7da doc: include compiler version in issue template 7 роки тому
link-roles.py b56ed1a99e docs: Correct Python coding style 7 роки тому
local_util.py 52cf8c39aa Download font file only is not exists in target location 6 роки тому
page_redirects.txt 05ac8cfb6d docs: Update description for Eclipse+Cmake support not ready yet 6 роки тому
requirements.txt 27fe2006de Fixed Breathe version to avoid docs build failure on ReadTheDocs server. Provided RTD project configuration file to be able to select python version for specific to esp-idf release. 6 роки тому
sphinx-known-warnings.txt 222146845c docs: Make CMake build system default, mark GNU Make as legacy option 6 роки тому

README.md

Documentation Source Folder

This folder contains source files of ESP-IDF documentation available in English and 中文.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated within about 20 minutes on each commit:

Hosted Documentation

The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.

Building Documentation

  • Install make and doxygen for your platform (make may already be installed as an ESP-IDF prerequisite).
  • Change to either the docs/en or docs/zh_CN subdirectory and run make html
  • make will probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-run make html to build the docs.

For MSYS2 MINGW32 on Windows

If using Windows and the MSYS2 MINGW32 terminal, run this command before running "make html" the first time:

pacman -S doxygen mingw-w64-i686-python2-pillow

Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.