홈 탐색 도움말
로그인
RT-Thread-packages
/
esp-idf
의 미러 https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
포크 0
파일 이슈 0 위키
트리: 94ca8b8917
브랜치 태그
esp-idf
/
docs
Angus Gratton 22487a65ac paritition_table: Verify the partition table md5sum when loading the app 5 년 전
..
_static 6e8529c08d ble_mesh: Doc miscellaneous fixes 5 년 전
en 22487a65ac paritition_table: Verify the partition table md5sum when loading the app 4 년 전
zh_CN 9a338bc8c3 docs: fix doxygen compile warnings for doxygen 1.9.1 4 년 전
Doxyfile 9a338bc8c3 docs: fix doxygen compile warnings for doxygen 1.9.1 4 년 전
README.md 14f4c196c0 windows: Update other MSYS2 package names to all be Python 3 5 년 전
TEMPLATE_EXAMPLE_README.md df4e227855 docs: Add "Creating Examples" docs page, template example README 7 년 전
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 7 년 전
conf_common.py 1177427aac docs: remove invalid arg in confgen invocation on docs generation 7 년 전
docs_common.mk 9911823658 docs: Add ESP-IDF support period policy 6 년 전
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 년 전
gen-toolchain-links.py 78003e9437 docs: Fix toolchain URL generation for macos 5 년 전
gen-version-specific-includes.py 6c2bffe53c build system: Also get IDF version from annotated tags only 5 년 전
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 년 전
issue_template.md 6c2bffe53c build system: Also get IDF version from annotated tags only 5 년 전
link-roles.py b56ed1a99e docs: Correct Python coding style 7 년 전
local_util.py b56ed1a99e docs: Correct Python coding style 7 년 전
requirements.txt d12048bcea Docs: Fix sphinxcontrib dependencies 6 년 전
sphinx-known-warnings.txt 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 년 전

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-python-pillow

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