صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
RT-Thread-packages
/
esp-idf
mirrorاز https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
درخت: 3bd4003e98
شاخه‌ها تگ‌ها
esp-idf
/
docs
suda-morris 471f4b2f0e zh_CN translation of fatal_error 6 سال پیش
..
_static 342f6a7829 Port NimBLE Host Stack on ESP-IDF 6 سال پیش
en 471f4b2f0e zh_CN translation of fatal_error 6 سال پیش
zh_CN 471f4b2f0e zh_CN translation of fatal_error 6 سال پیش
Doxyfile b75f8b1b20 ESP Local Control Feature Added 6 سال پیش
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 سال پیش
TEMPLATE_EXAMPLE_README.md df4e227855 docs: Add "Creating Examples" docs page, template example README 7 سال پیش
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 b24341a664 Merge make-related documents: 6 سال پیش
docs_common.mk 9daf51e6be Fix Python 3 compatibility issues 7 سال پیش
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 سال پیش
gen-toolchain-links.py 517c61a4ec docs: fix generation of toolchain links 6 سال پیش
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs 7 سال پیش
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 سال پیش
issue_template.md 9eeec5d7da doc: include compiler version in issue template 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 سال پیش
requirements.txt 27fe2006de Fixed Breathe version to avoid docs build failure on ReadTheDocs server. Provided RTD project configuration file to be able to select python version for specific to esp-idf release. 6 سال پیش
sphinx-known-warnings.txt 37cb673cd7 esp_flash: update the document to the latest API 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.