esp-idf/docs
Roland Dobai 9c1d4f5b54 Build & config: Remove the "make" build system
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
2021-11-10 09:53:53 +01:00
..
_static freertos: Fix SMP round robin scheduling 2021-11-02 14:00:14 +08:00
doxygen freertos: update freertos folder structure to match upstream 2021-10-29 12:05:13 +08:00
en Build & config: Remove the "make" build system 2021-11-10 09:53:53 +01:00
zh_CN Build & config: Remove the "make" build system 2021-11-10 09:53:53 +01:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py Build & config: Remove the "make" build system 2021-11-10 09:53:53 +01:00
doxygen-known-warnings.txt
generate_chart.py
page_redirects.txt
requirements.txt
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