首页 发现 帮助
登录
RT-Thread-packages
/
esp-idf
镜像自地址 https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
派生 0
文件 工单管理 0 Wiki
目录树: 18c753ba67
分支列表 标签列表
esp-idf
/
docs
Krzysztof 3bca931923 docs: Add profile file name used by zsh shell 5 年之前
..
_static 88f6e2b60d ble_mesh: Doc miscellaneous fixes 5 年之前
en 3bca931923 docs: Add profile file name used by zsh shell 5 年之前
zh_CN 5a0ee17ae2 Merge branch 'bugfix/remove_shortcut_to_build_instructions_v4.1' into 'release/v4.1' 5 年之前
Doxyfile 782fc0df5f Merge branch 'refactor/can_driver' into 'master' 6 年之前
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 年之前
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 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. 7 年之前
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 年之前
conf_common.py 4daa605bd3 gh_action: fix python lint 5 年之前
docs_common.mk dab3d1750e docs: Update Versions file in line with the latest Support Policy document 5 年之前
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 年之前
gen-toolchain-links.py c2db6a14c4 Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets 6 年之前
gen-version-specific-includes.py df61488e54 build system: Also get IDF version from annotated tags only 5 年之前
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 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 27e9cb785a feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 6 年之前
requirements.txt c74521f06d Docs: Fix sphinxcontrib dependencies 6 年之前
sphinx-known-warnings.txt 13f67d4279 doc: Remove duplicate ulp-cmake 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.