Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
RT-Thread-packages
/
esp-idf
zrkadlo https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Súbory Issues 0 Wiki
Strom: 2660cb82ae
Branche Tagy
esp-idf
/
docs
Angus Gratton 045fbd4574 Merge branch 'feature/kconfiglib_package' into 'master' 6 rokov pred
..
_static deda0091d9 Review the file api-reference/peripherals/spi_master.rst. 6 rokov pred
en 045fbd4574 Merge branch 'feature/kconfiglib_package' into 'master' 6 rokov pred
zh_CN 01887f71e7 Update kconfiglib to upstream version and replace mconf-idf 6 rokov pred
Doxyfile 7ce75a42c7 Merge branch 'master' into feature/esp32s2beta_merge 6 rokov pred
README.md b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 7 rokov pred
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 rokov pred
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 rokov pred
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 rokov pred
conf_common.py 01887f71e7 Update kconfiglib to upstream version and replace mconf-idf 6 rokov pred
docs_common.mk 5db1f5fdfb docs: Add ESP-IDF support period policy 6 rokov pred
gen-dxd.py b56ed1a99e docs: Correct Python coding style 7 rokov pred
gen-toolchain-links.py 517c61a4ec docs: fix generation of toolchain links 6 rokov pred
gen-version-specific-includes.py 0c44e5bfb3 doc: Fix invalid 'This command will clone master' note in docs 7 rokov pred
html_redirects.py b240a181b7 docs: Add option to redirect documentation pages which have moved 7 rokov pred
issue_template.md 9eeec5d7da doc: include compiler version in issue template 7 rokov pred
link-roles.py b56ed1a99e docs: Correct Python coding style 7 rokov pred
local_util.py 52cf8c39aa Download font file only is not exists in target location 6 rokov pred
page_redirects.txt 05ac8cfb6d docs: Update description for Eclipse+Cmake support not ready yet 6 rokov pred
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 rokov pred
sphinx-known-warnings.txt 222146845c docs: Make CMake build system default, mark GNU Make as legacy option 6 rokov pred

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.