esp-idf/docs
Jiang Jiang Jian d9dfa01c95 Merge branch 'bugfix/11kv_documentation' into 'master'
Add documentation for 802.11k and 802.11v APIs

See merge request espressif/esp-idf!15355
2021-10-20 10:22:22 +00:00
..
_static docs/update_esp32-s2_devkit_user_guides 2021-09-22 14:59:06 +08:00
doxygen Merge branch 'feature/add-conditional-section-tags-in-freertos-source-files' into 'master' 2021-10-11 08:46:32 +00:00
en Merge branch 'bugfix/11kv_documentation' into 'master' 2021-10-20 10:22:22 +00:00
zh_CN Merge branch 'bugfix/oocd_config_file_for_esp32s3' into 'master' 2021-10-19 19:07:54 +00:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py docs: enable publishing of S3 docs 2021-09-06 09:11:17 +08:00
doxygen-known-warnings.txt
generate_chart.py
page_redirects.txt
requirements.txt docs: bump esp-docs version to 0.1.1 2021-09-06 14:55:04 +08:00
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