alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-23 17:24:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
29e7456f37f5d89dd71f0a4380c27f1a0697918d
esp-idf/docs
History
morris 29e7456f37 Merge branch 'feature/spi_master_support_8-line_mode' into 'master' 
spi_master: support 8-line mode

Closes IDF-3354 and IDFGH-4553

See merge request espressif/esp-idf!14397
2021-08-19 13:19:34 +00:00
..
_static
docs/add_esp32-s2-devkitc-1_user_guide
2021-07-30 14:00:45 +08:00
doxygen
[esp_hw_support]: HMAC upstream support for S3
2021-08-13 12:01:06 +08:00
en
Merge branch 'feature/spi_master_support_8-line_mode' into 'master'
2021-08-19 13:19:34 +00:00
extensions
doc: Add support for redirects to external URL
2021-04-27 17:01:24 +08:00
idf_extensions
docs: add S3 TRM URL
2021-07-12 16:39:23 +08:00
latex_templates
Whitespace: Automated whitespace fixes (large commit)
2020-11-11 07:36:35 +00:00
test
docs: initial update of programming guide for C3
2021-02-01 15:40:02 +08:00
zh_CN
docs/update_module_flash_size_in_ESP32-S2-DevKitC-1_user_guide
2021-08-19 17:01:58 +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
[esp_hw_support]: HMAC upstream support for S3
2021-08-13 12:01:06 +08:00
doxygen-known-warnings.txt
…
generate_chart.py
style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +08:00
get_github_rev.py
docs: add 'edit-on-github' link to html theme
2020-05-06 17:25:23 +08:00
page_redirects.txt
doc: update tinyusb document to support esp32s3
2021-07-22 10:43:10 +08:00
README.md
…
requirements.txt
docs: add warning for outdated versions
2021-04-27 09:02:11 +08:00
sanitize_version.py
style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +08:00
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.