Trang chủ Khám phá Trợ giúp
Đăng nhập
RT-Thread-packages
/
esp-idf
mirror of https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Các tập tin Các vấn đề 0 Wiki
Tree: e989d59a4e
Branches Tags
esp-idf
/
docs
Angus Gratton 65f1be59ad Merge branch 'bugfix/idf_py_disable_cmake_warnings_default_v4.1' into 'release/v4.1' 5 năm trước cách đây
..
_static 88f6e2b60d ble_mesh: Doc miscellaneous fixes 5 năm trước cách đây
en 65f1be59ad Merge branch 'bugfix/idf_py_disable_cmake_warnings_default_v4.1' into 'release/v4.1' 5 năm trước cách đây
zh_CN 5a0ee17ae2 Merge branch 'bugfix/remove_shortcut_to_build_instructions_v4.1' into 'release/v4.1' 5 năm trước cách đây
Doxyfile 782fc0df5f Merge branch 'refactor/can_driver' into 'master' 6 năm trước cách đây
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 năm trước cách đây
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 năm trước cách đây
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 năm trước cách đây
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 năm trước cách đây
conf_common.py 4daa605bd3 gh_action: fix python lint 5 năm trước cách đây
docs_common.mk dab3d1750e docs: Update Versions file in line with the latest Support Policy document 5 năm trước cách đây
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 năm trước cách đây
gen-toolchain-links.py c2db6a14c4 Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets 6 năm trước cách đây
gen-version-specific-includes.py df61488e54 build system: Also get IDF version from annotated tags only 5 năm trước cách đây
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 năm trước cách đây
link-roles.py b56ed1a99e docs: Correct Python coding style 7 năm trước cách đây
local_util.py 52cf8c39aa Download font file only is not exists in target location 6 năm trước cách đây
page_redirects.txt 27e9cb785a feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 5 năm trước cách đây
requirements.txt c74521f06d Docs: Fix sphinxcontrib dependencies 6 năm trước cách đây
sphinx-known-warnings.txt 13f67d4279 doc: Remove duplicate ulp-cmake 6 năm trước cách đây

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.