alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
8d637ec985
esp-idf/docs
History
morris 8d637ec985 doc: redirect console page 
Previous the console doc is moved from api-guide to api-reference, which
broken the URL as well, this commit added a redirect link to ensure the
old URL can still work.
2022-11-02 14:21:57 +08:00
..
_static dac: optimize the dma stratege 2022-10-25 17:14:59 +08:00
docs_not_updated doc: update mcpwm for esp32c6 2022-10-20 11:55:03 +08:00
doxygen docs: Update esp_hmac references from doxyfile 2022-10-27 11:11:21 +05:30
en Merge branch 'docs/fix_usb_port_support_s3_user_guide' into 'master' 2022-10-27 14:44:55 +08:00
zh_CN Merge branch 'docs/fix_usb_port_support_s3_user_guide' into 'master' 2022-10-27 14:44:55 +08:00
check_lang_folder_sync.sh global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 2020-04-03 01:10:02 +02:00
conf_common.py Docs: Update folder structure for 5.1 migration 2022-10-25 15:16:27 +08:00
doxygen-known-warnings.txt docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
page_redirects.txt doc: redirect console page 2022-11-02 14:21:57 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt fatfs: Add mock option to ff_sdmmc_status function to increase IO speed 2022-06-09 20:09:32 +00:00
TEMPLATE_EXAMPLE_README.md docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +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