Startseite Erkunden Hilfe
Anmelden
RT-Thread-packages
/
esp-idf
Mirror von https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Dateien Issues 0 Wiki
Struktur: 97631de46c
Branches Tags
esp-idf
/
docs
Marius Vikhammer 7e839a82de docs: fix doxygen compile warnings for doxygen 1.9.1 vor 4 Jahren
..
_static 329ae0a987 docs: self host docs vor 5 Jahren
en 7e839a82de docs: fix doxygen compile warnings for doxygen 1.9.1 vor 4 Jahren
latex_templates 329ae0a987 docs: self host docs vor 5 Jahren
zh_CN 7e839a82de docs: fix doxygen compile warnings for doxygen 1.9.1 vor 4 Jahren
Doxyfile 7e839a82de docs: fix doxygen compile warnings for doxygen 1.9.1 vor 4 Jahren
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation vor 7 Jahren
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README vor 6 Jahren
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. vor 7 Jahren
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 vor 8 Jahren
conf_common.py 329ae0a987 docs: self host docs vor 5 Jahren
docs_common.mk dab3d1750e docs: Update Versions file in line with the latest Support Policy document vor 5 Jahren
gen-dxd.py b56ed1a99e docs: Correct Python coding style vor 7 Jahren
gen-toolchain-links.py c2db6a14c4 Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets vor 6 Jahren
gen-version-specific-includes.py 329ae0a987 docs: self host docs vor 5 Jahren
get_github_rev.py 329ae0a987 docs: self host docs vor 5 Jahren
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved vor 7 Jahren
latex_builder.py 329ae0a987 docs: self host docs vor 5 Jahren
link-roles.py e4af49ca23 docs: fix "link to translation" being broken vor 5 Jahren
local_util.py 52cf8c39aa Download font file only is not exists in target location vor 6 Jahren
page_redirects.txt 27e9cb785a feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 vor 6 Jahren
requirements.txt 329ae0a987 docs: self host docs vor 5 Jahren
sanitize_version.py 329ae0a987 docs: self host docs vor 5 Jahren
sphinx-known-warnings.txt 13f67d4279 doc: Remove duplicate ulp-cmake vor 6 Jahren

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.