Home Esplora Aiuto
Accedi
RT-Thread-packages
/
esp-idf
mirror da https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Forka 0
File Problemi 0 Wiki
Albero (Tree): e0d0200aed
Rami (Branch) Tag
esp-idf
/
docs
Wang Ning f87cbdee28 Add ESP32-S2-DevKitM-1 User Guide 5 anni fa
..
_static f87cbdee28 Add ESP32-S2-DevKitM-1 User Guide 5 anni fa
en f87cbdee28 Add ESP32-S2-DevKitM-1 User Guide 5 anni fa
extensions 63b76a9d90 doc: custom list filter directive 6 anni fa
idf_extensions 79887fdc6c soc: descriptive part occupy whole component 5 anni fa
latex_templates 407275f681 doc: add latex and PDF generation to build_docs 5 anni fa
test ba546a0d91 docs: Adds CI tests for the doc building process. 5 anni fa
zh_CN f87cbdee28 Add ESP32-S2-DevKitM-1 User Guide 5 anni fa
Doxyfile 40012f6648 docs: change some header path to use IDF_TARGET 5 anni fa
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 anni fa
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 anni fa
build_docs.py 9b552ce004 docs: add warning for doxygen version 5 anni fa
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 anni fa
conf_common.py 91cf7cc58d doc: dedicated gpio api reference 5 anni fa
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 anni fa
generate_chart.py 7a9abe3ec5 add chart of version support to version.rst 5 anni fa
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 anni fa
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 anni fa
requirements.txt 7a9abe3ec5 add chart of version support to version.rst 5 anni fa
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI 5 anni fa
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor 5 anni fa

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.