Главная Обзор Помощь
Вход
RT-Thread-packages
/
esp-idf
зеркало из https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Ответвить 0
Файлы Задачи 0 Вики
Дерево: 71df1f7422
Ветки Метки
esp-idf
/
docs
Angus Gratton a461605003 efuse: Add ESP32 V3 'disable Download Mode' functionality 5 лет назад
..
_static 6e8529c08d ble_mesh: Doc miscellaneous fixes 5 лет назад
en a461605003 efuse: Add ESP32 V3 'disable Download Mode' functionality 5 лет назад
zh_CN 228bec2371 add CN translation for adding python2 deprecation warning(MR 11115) 5 лет назад
Doxyfile ca6b009c26 esp_common: add version definitions in code and build system 5 лет назад
README.md 14f4c196c0 windows: Update other MSYS2 package names to all be Python 3 5 лет назад
TEMPLATE_EXAMPLE_README.md df4e227855 docs: Add "Creating Examples" docs page, template example README 7 лет назад
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. 6 лет назад
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 1177427aac docs: remove invalid arg in confgen invocation on docs generation 7 лет назад
docs_common.mk 9911823658 docs: Add ESP-IDF support period policy 6 лет назад
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 лет назад
gen-toolchain-links.py 78003e9437 docs: Fix toolchain URL generation for macos 5 лет назад
gen-version-specific-includes.py 6c2bffe53c build system: Also get IDF version from annotated tags only 5 лет назад
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 лет назад
issue_template.md 6c2bffe53c build system: Also get IDF version from annotated tags only 5 лет назад
link-roles.py b56ed1a99e docs: Correct Python coding style 7 лет назад
local_util.py b56ed1a99e docs: Correct Python coding style 7 лет назад
requirements.txt d12048bcea Docs: Fix sphinxcontrib dependencies 6 лет назад
sphinx-known-warnings.txt 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. 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-python-pillow

Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.