Inicio Explorar Axuda
Iniciar sesión
RT-Thread-packages
/
esp-idf
réplica de https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Ficheiros Incidencias 0 Wiki
Árbore: edb84c19dd
Ramas Etiquetas
esp-idf
/
docs
Island 3cfd7eebd1 Merge branch 'example/ble_mesh_structural_adjust_v4.1' into 'release/v4.1' %!s(int64=5) %!d(string=hai) anos
..
_static 88f6e2b60d ble_mesh: Doc miscellaneous fixes %!s(int64=5) %!d(string=hai) anos
en 3cfd7eebd1 Merge branch 'example/ble_mesh_structural_adjust_v4.1' into 'release/v4.1' %!s(int64=5) %!d(string=hai) anos
zh_CN 3cfd7eebd1 Merge branch 'example/ble_mesh_structural_adjust_v4.1' into 'release/v4.1' %!s(int64=5) %!d(string=hai) anos
Doxyfile 782fc0df5f Merge branch 'refactor/can_driver' into 'master' %!s(int64=6) %!d(string=hai) anos
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation %!s(int64=7) %!d(string=hai) anos
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README %!s(int64=6) %!d(string=hai) anos
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. %!s(int64=7) %!d(string=hai) anos
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 %!s(int64=8) %!d(string=hai) anos
conf_common.py 84d5cc1c17 Generate source files for kconfiglib from the build system %!s(int64=6) %!d(string=hai) anos
docs_common.mk 5db1f5fdfb docs: Add ESP-IDF support period policy %!s(int64=6) %!d(string=hai) anos
gen-dxd.py b56ed1a99e docs: Correct Python coding style %!s(int64=7) %!d(string=hai) anos
gen-toolchain-links.py c2db6a14c4 Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets %!s(int64=6) %!d(string=hai) anos
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs %!s(int64=7) %!d(string=hai) anos
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved %!s(int64=7) %!d(string=hai) anos
link-roles.py b56ed1a99e docs: Correct Python coding style %!s(int64=7) %!d(string=hai) anos
local_util.py 52cf8c39aa Download font file only is not exists in target location %!s(int64=6) %!d(string=hai) anos
page_redirects.txt 27e9cb785a feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 %!s(int64=6) %!d(string=hai) anos
requirements.txt c74521f06d Docs: Fix sphinxcontrib dependencies %!s(int64=6) %!d(string=hai) anos
sphinx-known-warnings.txt 13f67d4279 doc: Remove duplicate ulp-cmake %!s(int64=6) %!d(string=hai) anos

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.