Home Esplora Aiuto
Accedi
RT-Thread-packages
/
esp-idf
mirror da https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Forka 0
File Problemi 0 Wiki
Albero (Tree): 0e6ffd08b7
Rami (Branch) Tag
esp-idf
/
docs
Ivan Grokhotkov 0e6ffd08b7 docs: update msys environment links for esp32-2019r1 toolchain 6 anni fa
..
_static 4e95b1ad21 Provide getting started guide for 'ESP32-Ethernet-Kit' board 6 anni fa
en 0e6ffd08b7 docs: update msys environment links for esp32-2019r1 toolchain 6 anni fa
zh_CN 0e6ffd08b7 docs: update msys environment links for esp32-2019r1 toolchain 6 anni fa
Doxyfile b2e54a9cc6 ci: Add IDF_DEPRECATED macro for things we only deprecate in our CI passes 6 anni fa
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 anni fa
TEMPLATE_EXAMPLE_README.md df4e227855 docs: Add "Creating Examples" docs page, template example README 7 anni fa
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 anni fa
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 anni fa
conf_common.py 754a454402 Introduce separate fonts used by blockdiag, sequdiag, actdiag, nwdiag, rackdiag and packetdiag for Chinese and English version of documentation 6 anni fa
docs_common.mk 9daf51e6be Fix Python 3 compatibility issues 7 anni fa
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 anni fa
gen-toolchain-links.py b56ed1a99e docs: Correct Python coding style 7 anni fa
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs 7 anni fa
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 anni fa
issue_template.md 9eeec5d7da doc: include compiler version in issue template 7 anni fa
link-roles.py b56ed1a99e docs: Correct Python coding style 7 anni fa
local_util.py 52cf8c39aa Download font file only is not exists in target location 6 anni fa
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 anni fa
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. 7 anni fa

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.