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: 3748fdbbb3
Větve Značky
esp-idf
/
docs
Ivan Grokhotkov 76acc8ddde Merge branch 'feature/win_inst_embedded_python' into 'master' před 5 roky
..
_static 703aef654b provide user guide for ESP32-DevKitM-1 před 5 roky
doxygen 7c1c669799 component/bt: add BLE v5.0 feature for bluedroid host před 5 roky
en 76acc8ddde Merge branch 'feature/win_inst_embedded_python' into 'master' před 5 roky
extensions 63b76a9d90 doc: custom list filter directive před 6 roky
idf_extensions da947d736f Docs: Add C3 support to build_docs před 5 roky
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) před 5 roky
test ba546a0d91 docs: Adds CI tests for the doc building process. před 5 roky
zh_CN 76acc8ddde Merge branch 'feature/win_inst_embedded_python' into 'master' před 5 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 9b552ce004 docs: add warning for doxygen version před 5 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 da947d736f Docs: Add C3 support to build_docs před 5 roky
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings před 6 roky
generate_chart.py 7a9abe3ec5 add chart of version support to version.rst 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 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 před 5 roky
requirements.txt 88aa3c2463 docs: bump cairosvg from 2.4.2 to 2.5.1 in /docs před 5 roky
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI před 5 roky
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor před 5 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.