Domů Procházet Nápověda
Přihlásit se
RT-Thread-packages
/
esp-idf
zrcadlo https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki
Strom: 2ebaf53edc
Větve Značky
esp-idf
/
docs
Renz Christian Bagaporo 91b421c35f cmake: implement utility to import prebuilt libraries před 6 roky
..
_static 2daa8e6587 doc: update ble mesh docs based on the feature and example update před 6 roky
en 91b421c35f cmake: implement utility to import prebuilt libraries před 6 roky
zh_CN 8070746530 add updates to some files in api guides před 6 roky
Doxyfile 087c8f6065 essl: new component to communicate with esp serial slave devices před 6 roky
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation před 7 roky
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README před 6 roky
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. před 7 roky
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 před 7 roky
conf_common.py 84d5cc1c17 Generate source files for kconfiglib from the build system před 6 roky
docs_common.mk 5db1f5fdfb docs: Add ESP-IDF support period policy před 6 roky
gen-dxd.py b56ed1a99e docs: Correct Python coding style před 7 roky
gen-toolchain-links.py c2db6a14c4 Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets před 6 roky
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs před 7 roky
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved před 7 roky
issue_template.md 9eeec5d7da doc: include compiler version in issue template před 7 roky
link-roles.py b56ed1a99e docs: Correct Python coding style před 7 roky
local_util.py 52cf8c39aa Download font file only is not exists in target location před 6 roky
page_redirects.txt 1a012b7ad2 esp_netif: docs update to include tcpip_adapter migration guide před 6 roky
requirements.txt 27fe2006de Fixed Breathe version to avoid docs build failure on ReadTheDocs server. Provided RTD project configuration file to be able to select python version for specific to esp-idf release. před 6 roky
sphinx-known-warnings.txt 538540ce21 mcpwm: add HAL layer support před 6 roky

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.