Strona główna Odkrywaj Pomoc
Zaloguj się
RT-Thread-packages
/
esp-idf
kopia lustrzana https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Forkuj 0
Pliki Problemy 0 Wiki
Drzewo: 4636e8a34c
Gałęzie Tagi
esp-idf
/
docs
Angus Gratton 4636e8a34c docs/documenting-code: Add a couple of follow up notes on top of last commit 6 lat temu
..
_static 1cd6f67679 docs: add API guide page about IDF Tools 6 lat temu
en 4636e8a34c docs/documenting-code: Add a couple of follow up notes on top of last commit 6 lat temu
extensions e06a57f34f doc: Changed toc filter reg.ex to be non-greedy 6 lat temu
idf_extensions d03af45731 docs: flake8 fixes 6 lat temu
zh_CN d03af45731 docs: flake8 fixes 6 lat temu
Doxyfile 105567d077 doc: updated peripherals api-reference for s2 6 lat temu
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 lat temu
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 lat temu
build_docs.py d03af45731 docs: flake8 fixes 6 lat temu
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 lat temu
conf_common.py d03af45731 docs: flake8 fixes 6 lat temu
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 lat temu
page_redirects.txt 1a012b7ad2 esp_netif: docs update to include tcpip_adapter migration guide 6 lat temu
requirements.txt a148d8e6ba docs: Refactor extensions into packages, update the add-ons-reference docs page 6 lat temu
sphinx-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 lat temu

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.