Página inicial Explorar Ajuda
Entrar
RT-Thread-packages
/
esp-idf
mirror de https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Arquivos Issues 0 Wiki
Tree: bc60bbbeaf
Branches Tags
esp-idf
/
docs
Ivan Grokhotkov 3a779380a7 Merge branch 'feature/semihost_vfs' into 'master' 6 anos atrás
..
_static 7ffd0f95d2 doc/jtag_debug: translation of jtag debugging 7 anos atrás
en eee89118d9 Merge branch 'feature/idf_monitor_save_log' into 'master' 6 anos atrás
zh_CN bf5e3de955 Merge branch 'doc/app_trace_zh_CN' into 'master' 6 anos atrás
Doxyfile 3a779380a7 Merge branch 'feature/semihost_vfs' into 'master' 6 anos atrás
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 anos atrás
TEMPLATE_EXAMPLE_README.md df4e227855 docs: Add "Creating Examples" docs page, template example README 7 anos atrás
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 anos atrás
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 anos atrás
conf_common.py 49cca9288f Update IDF getting started sections for make and cmake as well as IDF monitor… 6 anos atrás
docs_common.mk 9daf51e6be Fix Python 3 compatibility issues 7 anos atrás
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 anos atrás
gen-toolchain-links.py b56ed1a99e docs: Correct Python coding style 7 anos atrás
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs 7 anos atrás
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 anos atrás
issue_template.md 9eeec5d7da doc: include compiler version in issue template 7 anos atrás
link-roles.py b56ed1a99e docs: Correct Python coding style 7 anos atrás
local_util.py b56ed1a99e docs: Correct Python coding style 7 anos atrás
requirements.txt 57b2d5ae56 docs: Upgraded sphinx package version to prevent build failures on readthedocs site. Upgraded versions of other packages that are used during documentation build. 6 anos atrás
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. 7 anos atrás

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.