Domů Procházet Nápověda
Přihlásit se
RT-Thread-packages
/
esp-idf
zrcadlo https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki
Strom: f5fcfec2cb
Větve Značky
esp-idf
/
docs
Cao Sen Miao fecf27e54c spi_flash: add support for 32Mbit address GD flash, for GD25Q256 před 4 roky
..
_static faee145a61 docs:add esp32-s3-devkitc-1 user guide před 4 roky
doxygen 59b49d2783 Merge branch 'feature/add-nimble-host-to-blufi' into 'master' před 4 roky
en fecf27e54c spi_flash: add support for 32Mbit address GD flash, for GD25Q256 před 4 roky
extensions 50fe1eea15 doc: Add support for redirects to external URL před 4 roky
idf_extensions bdfda351bd build docs: enable building of S3 docs před 4 roky
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) před 5 roky
test 548fd02d10 docs: initial update of programming guide for C3 před 5 roky
zh_CN fecf27e54c spi_flash: add support for 32Mbit address GD flash, for GD25Q256 před 4 roky
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer před 5 roky
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README před 6 roky
build_docs.py bdfda351bd build docs: enable building of S3 docs před 4 roky
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs před 5 roky
conf_common.py faee145a61 docs:add esp32-s3-devkitc-1 user guide před 4 roky
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings před 6 roky
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer před 5 roky
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme před 5 roky
page_redirects.txt c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' před 4 roky
requirements.txt e8b7d2ca08 docs: add warning for outdated versions před 4 roky
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer před 5 roky
sphinx-known-warnings.txt e07be3df49 docs: ignore duplicate def warning in BT docs před 4 roky

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.