esp-idf/docs
Zim Kalinowski ebaffab2fb Merge branch 'bugfix/freertos_round_robin_scheduling_retain_skip_v4.4' into 'release/v4.4'
freertos: Implement best effort round robin scheduling (v4.4)

See merge request espressif/esp-idf!15907
2021-11-15 07:47:43 +00:00
..
_static Merge branch 'bugfix/freertos_round_robin_scheduling_retain_skip_v4.4' into 'release/v4.4' 2021-11-15 07:47:43 +00:00
doxygen docs: define __DOXYGEN__ for doxygen builds 2021-10-27 17:10:26 +08:00
en Merge branch 'bugfix/freertos_round_robin_scheduling_retain_skip_v4.4' into 'release/v4.4' 2021-11-15 07:47:43 +00:00
zh_CN Merge branch 'doc/make_classic_bt_API_ref_only_for_esp32_4.4' into 'release/v4.4' 2021-11-08 09:14:24 +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 Merge branch 'doc/make_classic_bt_API_ref_only_for_esp32_4.4' into 'release/v4.4' 2021-11-08 09:14:24 +00: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