Почетна Преглед Помоћ
Пријавите се
RT-Thread-packages
/
esp-idf
огледало од https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: cfeb9e68cb
Гране Ознаке
esp-idf
/
docs
Marius Vikhammer cfeb9e68cb doc: Changed Chinese doc to use dynamic chip name пре 6 година
..
_static 1cd6f67679 docs: add API guide page about IDF Tools пре 6 година
en a7bac4721a doc: Add external ram note link to CN translation пре 6 година
extensions e06a57f34f doc: Changed toc filter reg.ex to be non-greedy пре 6 година
idf_extensions c848aa74ac doc: Add extension that replaces generic target variable with idf_target пре 6 година
zh_CN cfeb9e68cb doc: Changed Chinese doc to use dynamic chip name пре 6 година
Doxyfile d97b587871 docs: Clear _Static_assert related warnings пре 6 година
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation пре 7 година
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README пре 6 година
build_docs.py a148d8e6ba docs: Refactor extensions into packages, update the add-ons-reference docs page пре 6 година
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 пре 8 година
conf_common.py d56ea52ea1 doc: EN doc update and fixed warnings пре 6 година
page_redirects.txt 1a012b7ad2 esp_netif: docs update to include tcpip_adapter migration guide пре 6 година
requirements.txt a148d8e6ba docs: Refactor extensions into packages, update the add-ons-reference docs page пре 6 година
sphinx-known-warnings.txt d97b587871 docs: Clear _Static_assert related warnings пре 6 година

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.