صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
RT-Thread-packages
/
esp-idf
mirrorاز https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
درخت: e3a786f2cf
شاخه‌ها تگ‌ها
esp-idf
/
docs
He Yin Ling 783cb692e8 unit-test-app: support passing parameter with signals 7 سال پیش
..
_static 3dcc0ae908 docs: Adds watchpoints limit configuration to example gdbinit 7 سال پیش
en 783cb692e8 unit-test-app: support passing parameter with signals 7 سال پیش
zh_CN 783cb692e8 unit-test-app: support passing parameter with signals 7 سال پیش
Doxyfile 6a4955ef74 doc: Rearrange wifi & ethernet docs into a common "network" doc 7 سال پیش
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 سال پیش
TEMPLATE_EXAMPLE_README.md df4e227855 docs: Add "Creating Examples" docs page, template example README 7 سال پیش
check_doc_warnings.sh c63d7a4b5e Adjusted CI configuration to handle 'en' and 'zh_CN' language versions 8 سال پیش
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 7254476acb docs: list kconfig components alphabetically via component name 7 سال پیش
docs_common.mk 9daf51e6be Fix Python 3 compatibility issues 7 سال پیش
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 سال پیش
gen-toolchain-links.py b56ed1a99e docs: Correct Python coding style 7 سال پیش
gen-version-specific-includes.py 88150cb9bb docs: Make Getting Started (CMake) guides version-aware 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 b56ed1a99e docs: Correct Python coding style 7 سال پیش
requirements.txt c3d99dd2e4 Encourage to install python packages without administrative rights 7 سال پیش
sphinx-known-warnings.txt 7cc6b3c5ec Upgraded Sphinx to latest release 1.6.5 that contains a fix to https://github.com/sphinx-doc/sphinx/issues/4041. Upgraded Breathe to latest release 4.7.3 as well. 8 سال پیش

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.