esp-idf/docs
Mahavir Jain 11abb67e65 Merge branch 'fix/update_migration_guide_for_esp_ds_api' into 'master'
docs/protocols/migration_guide: Update the v5.0 migration guide w.r.t.

See merge request espressif/esp-idf!17760
2022-04-14 13:30:41 +08:00
..
_static docs: update s3-devkitc-1 user guide 2022-03-29 11:24:20 +08:00
docs_not_updated spi: support spi on h2 2022-03-29 11:54:08 +08:00
doxygen clk_tree: prework of introducing clk subsystem control 2022-04-11 12:09:06 +08:00
en Merge branch 'fix/update_migration_guide_for_esp_ds_api' into 'master' 2022-04-14 13:30:41 +08:00
zh_CN Merge branch 'docs/update_documents_in_hw_reference' into 'master' 2022-04-14 11:19:46 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py
doxygen-known-warnings.txt
page_redirects.txt
requirements.txt docs: update esp-docs version to 0.2.4 2022-04-06 21:03:59 +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