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: ca3df7de7f
Branches Tags
esp-idf
/
docs
Angus Gratton 3201333f06 Merge branch 'bugfix/flash_encryption_disable_plaintext_v3.3' into 'release/v3.3' vor 6 Jahren
..
_static 4cb729283d Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs. vor 6 Jahren
en 3201333f06 Merge branch 'bugfix/flash_encryption_disable_plaintext_v3.3' into 'release/v3.3' vor 6 Jahren
zh_CN 4cb729283d Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs. vor 6 Jahren
Doxyfile f94db7bba7 wifi_provisioning : Added Wi-Fi Scan list feature to Provisioning Manager vor 6 Jahren
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation vor 7 Jahren
TEMPLATE_EXAMPLE_README.md df4e227855 docs: Add "Creating Examples" docs page, template example README vor 7 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 1177427aac docs: remove invalid arg in confgen invocation on docs generation vor 7 Jahren
docs_common.mk 9daf51e6be Fix Python 3 compatibility issues vor 7 Jahren
gen-dxd.py b56ed1a99e docs: Correct Python coding style vor 7 Jahren
gen-toolchain-links.py b56ed1a99e docs: Correct Python coding style vor 7 Jahren
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs vor 7 Jahren
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved vor 7 Jahren
issue_template.md 9eeec5d7da doc: include compiler version in issue template vor 7 Jahren
link-roles.py b56ed1a99e docs: Correct Python coding style vor 7 Jahren
local_util.py b56ed1a99e docs: Correct Python coding style vor 7 Jahren
requirements.txt 3cbbc3bbac Fix Breathe version to avoid docs build failure on ReadTheDocs server. Provide RTD project configuration file to be able to select python version for specific to esp-idf release. (backport v3.3) vor 6 Jahren
sphinx-known-warnings.txt 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

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.