Startsida Utforska Hjälp
Logga in
RT-Thread-packages
/
esp-idf
spegling av https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Filer Ärenden 0 Wiki
Träd: df3f2f4cb0
Grenar Taggar
esp-idf
/
docs
Angus Gratton a9854f7085 Merge branch 'feature/rmt_clock_support_ref_tick' into 'master' 6 år sedan
..
_static 2178e3fba4 docs: Update getting started guide for ESP32-S2 target 6 år sedan
en a9854f7085 Merge branch 'feature/rmt_clock_support_ref_tick' into 'master' 6 år sedan
extensions 63b76a9d90 doc: custom list filter directive 6 år sedan
idf_extensions dfc95bc78b docs: multi target include dir support 6 år sedan
zh_CN a9854f7085 Merge branch 'feature/rmt_clock_support_ref_tick' into 'master' 6 år sedan
Doxyfile 947e3e94ed Add ESP certificate bundle feature 6 år sedan
README.md 291735c7dd docs: Move to Python 3.5+ and Sphinx 2.3 6 år sedan
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 år sedan
build_docs.py ef7b5ff9e4 bugfix/build_docs_add_warning_check: Added null value check for warnings 6 år sedan
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 år sedan
conf_common.py f96c374254 Merge branch 'doc/multi_target_list' into 'master' 6 år sedan
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 år sedan
page_redirects.txt 073ba0a608 feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 6 år sedan
requirements.txt 291735c7dd docs: Move to Python 3.5+ and Sphinx 2.3 6 år sedan
sphinx-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 år sedan

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

  • Documentation build requres Python 3 and will not work with Python 2
  • Install dependencies for ESP-IDF as per the Getting Started guide
  • Install documentation Python depdendencies, ie pip install -r $IDF_PATH/docs/requirements.txt
  • Run ./build_docs.py build to build docs for all supported Language & Target combinations, or ./build_docs.py -t esp32 -l en build to build docs for a single supported language & target combination only.

See Documenting Code for more information.

Available languages are en and zh_CN, targets are any target supported by ESP-IDF - for example esp32 or esp32s2.