alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
2ec907e621
esp-idf/docs
History
morris a1bc70475a Merge branch 'docs/update_cn_trans_for_speed_optimization' into 'master' 
docs: Update CN for speed.rst

Closes DOC-6362

See merge request espressif/esp-idf!26051
2023-09-25 16:11:56 +08:00
..
_static docs: add troubleshooting notes to establish-serial-connection.rst 2023-09-12 17:53:36 +08:00
docs_not_updated Merge branch 'feature/support_rmt_esp32p4' into 'master' 2023-09-20 23:11:11 +08:00
doxygen Merge branch 'feature/rename_wpa2_ent_to_eap_client' into 'master' 2023-09-18 16:16:54 +08:00
en Merge branch 'docs/update_cn_trans_for_speed_optimization' into 'master' 2023-09-25 16:11:56 +08:00
zh_CN Merge branch 'docs/update_cn_trans_for_speed_optimization' into 'master' 2023-09-25 16:11:56 +08:00
check_lang_folder_sync.sh global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 2020-04-03 01:10:02 +02:00
conf_common.py feat(doc): update wifi sections for H2 2023-08-31 19:27:51 +08:00
doxygen-known-warnings.txt feat(mqtt): Updates submodule to 05b3476 2023-09-04 15:33:34 +02:00
page_redirects.txt doc: remove left-over legacy event loop docs 2023-03-17 15:37:26 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt fix(ble_mesh): Miscellaneous update for ble mesh 2023-09-16 15:58:14 +08:00
TEMPLATE_EXAMPLE_README.md docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +08:00

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