Home Explore Help
Sign In
RT-Thread-packages
/
esp-idf
mirror of https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: v4.1.3
Branches Tags
esp-idf
/
docs
Sergei Silnov 5717288cd7 docs: Add component manager documentation 4 years ago
..
_static 1738f01c10 docs: update Windows Tools 2.9 installation 4 years ago
en 5717288cd7 docs: Add component manager documentation 4 years ago
latex_templates 329ae0a987 docs: self host docs 5 years ago
zh_CN 5717288cd7 docs: Add component manager documentation 4 years ago
Doxyfile 7e839a82de docs: fix doxygen compile warnings for doxygen 1.9.1 4 years ago
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 years ago
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 years ago
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 years ago
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 years ago
conf_common.py 329ae0a987 docs: self host docs 5 years ago
docs_common.mk dab3d1750e docs: Update Versions file in line with the latest Support Policy document 5 years ago
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 years ago
gen-toolchain-links.py c2db6a14c4 Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets 6 years ago
gen-version-specific-includes.py 329ae0a987 docs: self host docs 5 years ago
get_github_rev.py 329ae0a987 docs: self host docs 5 years ago
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 years ago
latex_builder.py 329ae0a987 docs: self host docs 5 years ago
link-roles.py e4af49ca23 docs: fix "link to translation" being broken 4 years ago
local_util.py 52cf8c39aa Download font file only is not exists in target location 6 years ago
page_redirects.txt 27e9cb785a feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 5 years ago
requirements.txt 329ae0a987 docs: self host docs 5 years ago
sanitize_version.py 329ae0a987 docs: self host docs 5 years ago
sphinx-known-warnings.txt 13f67d4279 doc: Remove duplicate ulp-cmake 6 years ago

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.