Sākums Izpētīt Palīdzība
Pierakstīties
RT-Thread-packages
/
esp-idf
spogulis no https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Atdalīts 0
Faili Problēmas 0 Vikivietne
Koks: f73cd1d4f1
Atzari Tagi
esp-idf
/
docs
Ivan Grokhotkov 1e95aba03a Merge branch 'feature/msys2_env_update_v4.0' into 'release/v4.0' 5 gadi atpakaļ
..
_static cdd35648b7 ble_mesh: Doc miscellaneous fixes 5 gadi atpakaļ
en 1e95aba03a Merge branch 'feature/msys2_env_update_v4.0' into 'release/v4.0' 5 gadi atpakaļ
zh_CN 1e95aba03a Merge branch 'feature/msys2_env_update_v4.0' into 'release/v4.0' 5 gadi atpakaļ
Doxyfile 27628ef133 Merge branch 'doc/add_ble_mesh_doxyfile' into 'master' 6 gadi atpakaļ
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 gadi atpakaļ
TEMPLATE_EXAMPLE_README.md 47bbb107a8 build system: Use CMake-based build system as default when describing commands 6 gadi atpakaļ
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 gadi atpakaļ
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 gadi atpakaļ
conf_common.py b53c59b7a4 tools: fix python lint 5 gadi atpakaļ
docs_common.mk 5e505898df docs: Add ESP-IDF support period policy 6 gadi atpakaļ
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 gadi atpakaļ
gen-toolchain-links.py 2cd3018c0a Introduce esp-2019r2 toolchain 6 gadi atpakaļ
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs 7 gadi atpakaļ
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 gadi atpakaļ
issue_template.md 9eeec5d7da doc: include compiler version in issue template 7 gadi atpakaļ
link-roles.py b56ed1a99e docs: Correct Python coding style 7 gadi atpakaļ
local_util.py 52cf8c39aa Download font file only is not exists in target location 6 gadi atpakaļ
page_redirects.txt 05ac8cfb6d docs: Update description for Eclipse+Cmake support not ready yet 6 gadi atpakaļ
requirements.txt 70d4d32511 Docs: Fix sphinxcontrib dependencies 6 gadi atpakaļ
sphinx-known-warnings.txt 222146845c docs: Make CMake build system default, mark GNU Make as legacy option 6 gadi atpakaļ

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.