esp-idf/docs
Wang Ning e6b7f4cefa Merge branch 'docs/update_folder_structure_for_5.1_migration' into 'master'
Docs: Update folder structure for 5.1 migration

See merge request espressif/esp-idf!20754
2022-10-25 15:16:27 +08:00
..
_static
docs_not_updated
doxygen
en Merge branch 'docs/update_folder_structure_for_5.1_migration' into 'master' 2022-10-25 15:16:27 +08:00
zh_CN Merge branch 'docs/update_folder_structure_for_5.1_migration' into 'master' 2022-10-25 15:16:27 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py Docs: Update folder structure for 5.1 migration 2022-10-25 15:16:27 +08:00
doxygen-known-warnings.txt
page_redirects.txt
sphinx-known-warnings.txt

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

The documentation is built using the python package esp-docs, which can be installed by running pip install esp-docs. Running build-docs --help will give a summary of available options. For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md