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
97da3e9ed5
esp-idf/docs
History
Michael (XIAO Xufeng) e8ff60544d Merge branch 'bugfix/channel_clk_independent' into 'master' 
rmt: clean up and support esp32-s3 (no DMA support)

Closes IDF-3296 and IDFGH-5350

See merge request espressif/esp-idf!13244
2021-07-01 04:37:07 +00:00
..
_static docs: update Windows Tools 2.9 installation 2021-06-21 14:19:40 +02:00
doxygen Merge branch 'feature/add-nimble-host-to-blufi' into 'master' 2021-06-29 12:54:01 +00:00
en Merge branch 'bugfix/channel_clk_independent' into 'master' 2021-07-01 04:37:07 +00:00
extensions doc: Add support for redirects to external URL 2021-04-27 17:01:24 +08:00
idf_extensions build docs: enable building of S3 docs 2021-06-09 09:30:36 +08:00
latex_templates
test docs: initial update of programming guide for C3 2021-02-01 15:40:02 +08:00
zh_CN docs:fixthe number of general purpose timers for ESP32-C3 2021-06-29 14:33:06 +08:00
build_docs.py build docs: enable building of S3 docs 2021-06-09 09:30:36 +08:00
check_lang_folder_sync.sh
conf_common.py build docs: enable building of S3 docs 2021-06-09 09:30:36 +08:00
doxygen-known-warnings.txt
generate_chart.py
get_github_rev.py
page_redirects.txt Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' 2021-05-31 11:12:51 +00:00
README.md
requirements.txt docs: add warning for outdated versions 2021-04-27 09:02:11 +08:00
sanitize_version.py
sphinx-known-warnings.txt docs: ignore duplicate def warning in BT docs 2021-06-30 15:10:43 +08:00
TEMPLATE_EXAMPLE_README.md

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 build requirements Python 3 and running the wrapper ./build_docs.py tool. Running ./build_docs.py --help will give a summary of available options.

See Documenting Code in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the ./build_docs.py tool.