Home Verkennen Help
Inloggen
RT-Thread-packages
/
esp-idf
spiegel van https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Vork 0
Bestanden Issues 0 Wiki
Boom: e24ac7a346
Aftakkingen Labels
esp-idf
/
docs
fivdi 178c9d15de Fix comments in ULP MOVE instruction examples 7 jaren geleden
..
_static 7ffd0f95d2 doc/jtag_debug: translation of jtag debugging 7 jaren geleden
en 178c9d15de Fix comments in ULP MOVE instruction examples 6 jaren geleden
zh_CN 416b756ea4 Merge branch 'bugfix/name_conflict_esp32_project_ld' into 'master' 7 jaren geleden
Doxyfile ba903e7618 docs: Add efuse 7 jaren geleden
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 jaren geleden
TEMPLATE_EXAMPLE_README.md df4e227855 docs: Add "Creating Examples" docs page, template example README 7 jaren geleden
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 jaren geleden
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 jaren geleden
conf_common.py 49cca9288f Update IDF getting started sections for make and cmake as well as IDF monitor… 7 jaren geleden
docs_common.mk 9daf51e6be Fix Python 3 compatibility issues 7 jaren geleden
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 jaren geleden
gen-toolchain-links.py b56ed1a99e docs: Correct Python coding style 7 jaren geleden
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs 7 jaren geleden
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 jaren geleden
issue_template.md 9eeec5d7da doc: include compiler version in issue template 7 jaren geleden
link-roles.py b56ed1a99e docs: Correct Python coding style 7 jaren geleden
local_util.py b56ed1a99e docs: Correct Python coding style 7 jaren geleden
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 jaren geleden
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 jaren geleden

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.