Strona główna Odkrywaj Pomoc
Zaloguj się
RT-Thread-packages
/
esp-idf
kopia lustrzana https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Forkuj 0
Pliki Problemy 0 Wiki
Drzewo: f9802da461
Gałęzie Tagi
esp-idf
/
docs
Angus Gratton 3a451afb82 doc: Update the legacy MSYS2 environment to use 2019r2 toolchain version 6 lat temu
..
_static e969115a23 Fix the whitespace after everything which is link 6 lat temu
en 3a451afb82 doc: Update the legacy MSYS2 environment to use 2019r2 toolchain version 6 lat temu
zh_CN 17b5df4d72 Merge branch 'feature/function_call_with_stack' into 'master' 6 lat temu
Doxyfile dfea4196a2 docs: added esp-expression-with-stack on documentation 6 lat temu
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 lat temu
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 lat temu
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 lat temu
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 7 lat temu
conf_common.py 84d5cc1c17 Generate source files for kconfiglib from the build system 6 lat temu
docs_common.mk 5db1f5fdfb docs: Add ESP-IDF support period policy 6 lat temu
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 lat temu
gen-toolchain-links.py c2db6a14c4 Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets 6 lat temu
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs 7 lat temu
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 lat temu
link-roles.py b56ed1a99e docs: Correct Python coding style 7 lat temu
local_util.py 52cf8c39aa Download font file only is not exists in target location 6 lat temu
page_redirects.txt 1a012b7ad2 esp_netif: docs update to include tcpip_adapter migration guide 6 lat temu
requirements.txt ef0c26bfce doc: Limit sphinxcontrib versions to <2.0.0 as we use Sphinx 1.8.5 6 lat temu
sphinx-known-warnings.txt 8fe3ecd000 Added description for difference between ESP32 ULP and ESP32-S2 ULP 6 lat temu

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.