esp-idf/docs
Jiang Jiang Jian be8129dc2d Merge branch 'bugfix/doc_static_Files_v4.4' into 'release/v4.4'
docs: fix missing static file path (v4.4)

See merge request espressif/esp-idf!17329
2022-06-09 10:56:28 +08:00
..
_static docs: fix missing static file path 2022-03-03 10:48:20 +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/backport_certificate_bundle_fixes_v4.4' into 'release/v4.4' 2022-06-03 16:27:47 +08:00
zh_CN spiffs: Add esp_spiffs_check() function 2022-05-27 21:14:33 +00:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py docs: fix missing static file path 2022-03-03 10:48:20 +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