esp-idf/docs
Michael (XIAO Xufeng) 246f72020f Merge branch 'bugfix/modbus_port_fix_lgpl_licensed_files_v4.4' into 'release/v4.4'
freemodbus: fix port contains lgpl licensed files (v4.4)

See merge request espressif/esp-idf!16550
2022-02-12 20:43:22 +00:00
..
_static docs:update ESP32-DevKitC Pin Layout figure of higher resolution 2022-01-27 17:05:01 +08:00
doxygen Merge branch 'bugfix/doc_for_ipc_isr_v4.4' into 'release/v4.4' 2021-12-24 03:35:54 +00:00
en Merge branch 'bugfix/modbus_port_fix_lgpl_licensed_files_v4.4' into 'release/v4.4' 2022-02-12 20:43:22 +00:00
zh_CN Merge branch 'docs/pinlayout_image_update_backport_v4.4' into 'release/v4.4' 2022-01-28 03:22:51 +00:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py docs: fix html redirects not working 2021-12-07 09:12:46 +08: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