esp-idf/docs
Mahavir Jain 5faf116d26 Merge branch 'docs/esp_https_server_api_cleanup' into 'master'
docs: Updated migration guide for esp_https_server API breaking changes

Closes IDF-4678

See merge request espressif/esp-idf!17360
2022-03-06 14:26:55 +08:00
..
_static docs: update esp wrover kit user guide 2022-02-24 15:14:38 +08:00
docs_not_updated uart: Provide support for esp32c2 and esp32h2 2022-03-02 11:29:13 +08:00
doxygen doc: update API reference for pulse_cnt driver 2022-03-03 22:38:32 +08:00
en Merge branch 'docs/esp_https_server_api_cleanup' into 'master' 2022-03-06 14:26:55 +08:00
zh_CN Merge branch 'docs/ulp_documentation_updates' into 'master' 2022-03-03 19:16:27 +08:00
README.md
TEMPLATE_EXAMPLE_README.md docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +08:00
check_lang_folder_sync.sh
conf_common.py docs: Updated ULP documentation 2022-03-01 09:02:41 +05:30
doxygen-known-warnings.txt
page_redirects.txt docs: Updated ULP documentation 2022-03-01 09:02:41 +05:30
requirements.txt docs: update esp-docs, rename esp8684 to esp32c2 2022-01-21 09:26:35 +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