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
0498c1ced4
esp-idf/docs
History
Yi Ying d8b34c739a Merge branch 'docs/add_bluetooth_overview_page' into 'master' 
docs: add bluetooth overview

Closes DOC-5644

See merge request espressif/esp-idf!25030
2023-08-16 19:02:16 +08:00
..
_static docs (Bluetooth): add bluetooth overview document 2023-08-15 11:13:14 +08:00
docs_not_updated docs(esp32p4): added building docs for ESP32-P4 2023-08-16 10:13:47 +08:00
doxygen docs(esp32p4): added building docs for ESP32-P4 2023-08-16 10:13:47 +08:00
en Merge branch 'docs/add_bluetooth_overview_page' into 'master' 2023-08-16 19:02:16 +08:00
zh_CN Merge branch 'docs/add_bluetooth_overview_page' into 'master' 2023-08-16 19:02:16 +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 Merge branch 'docs/add_bluetooth_overview_page' into 'master' 2023-08-16 19:02:16 +08:00
doxygen-known-warnings.txt freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS 2022-12-23 15:29:17 +08: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 docs(fatfs): Move mentioned APIs to a separate API reference section 2023-08-04 23:47:44 +00: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