Почетна Преглед Помоћ
Пријавите се
RT-Thread-packages
/
esp-idf
огледало од https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: cc3df01f8f
Гране Ознаке
esp-idf
/
docs
Krzysztof Budzynski ac27ab29fd doc: Fix broken links to examples пре 6 година
..
_static c5f77cf6cb Review the file api-reference/peripherals/i2c.rst пре 6 година
en ac27ab29fd doc: Fix broken links to examples пре 6 година
zh_CN ac27ab29fd doc: Fix broken links to examples пре 6 година
Doxyfile 782fc0df5f Merge branch 'refactor/can_driver' into 'master' пре 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 година
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 пре 7 година
conf_common.py 84d5cc1c17 Generate source files for kconfiglib from the build system пре 6 година
docs_common.mk 5db1f5fdfb docs: Add ESP-IDF support period policy пре 6 година
gen-dxd.py b56ed1a99e docs: Correct Python coding style пре 7 година
gen-toolchain-links.py c2db6a14c4 Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets пре 6 година
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs пре 7 година
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved пре 7 година
link-roles.py b56ed1a99e docs: Correct Python coding style пре 7 година
local_util.py 52cf8c39aa Download font file only is not exists in target location пре 6 година
page_redirects.txt 1a012b7ad2 esp_netif: docs update to include tcpip_adapter migration guide пре 6 година
requirements.txt ef0c26bfce doc: Limit sphinxcontrib versions to <2.0.0 as we use Sphinx 1.8.5 пре 6 година
sphinx-known-warnings.txt 13f67d4279 doc: Remove duplicate ulp-cmake пре 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.