esp-idf/docs
Jiang Jiang Jian d4080633f9 Merge branch 'feature/efuse_rev_major_minor_v4.4' into 'release/v4.4'
efuse: Adds major and minor versions (v4.4)

See merge request espressif/esp-idf!19541
2023-01-12 16:24:59 +08:00
..
_static docs: fix missing static file path 2022-03-03 10:48:20 +08:00
doxygen freemodbus: remove component files from esp-idf (backport v4.4) 2022-12-22 17:05:55 +08:00
en Merge branch 'feature/efuse_rev_major_minor_v4.4' into 'release/v4.4' 2023-01-12 16:24:59 +08:00
zh_CN Merge branch 'doc/cpu_breakpoint_watchpoint_num_v4.4' into 'release/v4.4' 2022-12-22 19:29:06 +08: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 docs: fix all doxygen warnings 2022-07-05 11:14:40 +08:00
doxygen-known-warnings.txt docs: fix all doxygen warnings 2022-07-05 11:14:40 +08:00
generate_chart.py
page_redirects.txt doc: redirect console page 2022-11-02 16:08:07 +08:00
requirements.txt docs: fix all doxygen warnings 2022-07-05 11:14:40 +08:00
sphinx-known-warnings.txt component_bt: Fix build doc errors of bt 2022-08-02 13:39:36 +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