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: 268816649c
Grenar Taggar
esp-idf
/
docs
Marius Vikhammer 268816649c Replace all TRM urls will generic template variable and remove duplicate sections 6 år sedan
..
_static 1cd6f67679 docs: add API guide page about IDF Tools 6 år sedan
en 268816649c Replace all TRM urls will generic template variable and remove duplicate sections 6 år sedan
extensions e06a57f34f doc: Changed toc filter reg.ex to be non-greedy 6 år sedan
idf_extensions 268816649c Replace all TRM urls will generic template variable and remove duplicate sections 6 år sedan
zh_CN 268816649c Replace all TRM urls will generic template variable and remove duplicate sections 6 år sedan
Doxyfile 105567d077 doc: updated peripherals api-reference for s2 6 år sedan
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 år sedan
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 år sedan
build_docs.py b9effd8c06 fixup build_docs.py, show doxygen and sphinx warnings together 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 1a90470f02 doc: Split HW-Reference into seperate files/folders for different chips 6 år sedan
doxygen-known-warnings.txt fb3edc9c87 docs: Add features to build_docs.py: check warnings, check links, check GH links 6 år sedan
page_redirects.txt 1a012b7ad2 esp_netif: docs update to include tcpip_adapter migration guide 6 år sedan
requirements.txt a148d8e6ba docs: Refactor extensions into packages, update the add-ons-reference docs page 6 år sedan
sphinx-known-warnings.txt fb3edc9c87 docs: Add features to build_docs.py: check warnings, check links, check GH links 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

  • 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.