Главная Обзор Помощь
Вход
RT-Thread-packages
/
esp-idf
зеркало из https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Ответвить 0
Файлы Задачи 0 Вики
Дерево: 85c2df060d
Ветки Метки
esp-idf
/
docs
Angus Gratton 04ae56806c Merge branch 'master' into feature/esp32s2beta_update 6 лет назад
..
_static 639687f92b Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs. 6 лет назад
en 04ae56806c Merge branch 'master' into feature/esp32s2beta_update 6 лет назад
zh_CN 04ae56806c Merge branch 'master' into feature/esp32s2beta_update 6 лет назад
Doxyfile 24d26fccde Merge branch 'master' into feature/esp32s2beta_update 6 лет назад
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 лет назад
TEMPLATE_EXAMPLE_README.md 47bbb107a8 build system: Use CMake-based build system as default when describing commands 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. 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 86dbe9299a docs: Load page redirects from a file instead of inline in config 6 лет назад
docs_common.mk 9daf51e6be Fix Python 3 compatibility issues 7 лет назад
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 лет назад
gen-toolchain-links.py 517c61a4ec docs: fix generation of toolchain links 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 лет назад
issue_template.md 9eeec5d7da doc: include compiler version in issue template 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 05ac8cfb6d docs: Update description for Eclipse+Cmake support not ready yet 6 лет назад
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. 6 лет назад
sphinx-known-warnings.txt 222146845c docs: Make CMake build system default, mark GNU Make as legacy option 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.