esp-idf/docs
Simon fc14d3f9aa Merge branch 'doc/update_usj_docs' into 'master'
docs: update usb_serial_jtag documents

Closes IDF-3202 and DOC-2301

See merge request espressif/esp-idf!15922
2021-11-23 07:41:53 +00:00
..
_static Doc/add esp32s3 kevkitm 1 user guide cn and en 2021-11-17 11:13:34 +00:00
doxygen esp_ipc: Update documentation and API descriptions 2021-11-18 21:34:50 +08:00
en Merge branch 'doc/update_usj_docs' into 'master' 2021-11-23 07:41:53 +00:00
zh_CN Merge branch 'doc/update_usj_docs' into 'master' 2021-11-23 07:41:53 +00: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