Startsida Utforska Hjälp
Logga in
RT-Thread-packages
/
esp-idf
spegling av https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Filer Ärenden 0 Wiki
Träd: 44f663447e
Grenar Taggar
esp-idf
/
docs
martin.gano 44f663447e docs: add description of python-clean command 5 år sedan
..
_static e0a698c242 add docs "How to improve Wi-Fi performance" in api-guides. 5 år sedan
en 44f663447e docs: add description of python-clean command 5 år sedan
extensions 63b76a9d90 doc: custom list filter directive 6 år sedan
idf_extensions c8cd68fbe6 docs: add sphinx warnings in format_idf_target 5 år sedan
latex_templates 407275f681 doc: add latex and PDF generation to build_docs 5 år sedan
test ba546a0d91 docs: Adds CI tests for the doc building process. 5 år sedan
zh_CN 068690e604 Merge branch 'docs/fix_formatting_issues_in_idf_monitor' into 'master' 5 år sedan
Doxyfile a3cc43485f async memcpy: support async memcopy on esp32s2/s3 5 år sedan
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 år sedan
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 år sedan
build_docs.py 9b552ce004 docs: add warning for doxygen version 5 år sedan
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 år sedan
conf_common.py 7a9abe3ec5 add chart of version support to version.rst 5 år sedan
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 år sedan
generate_chart.py 7a9abe3ec5 add chart of version support to version.rst 5 år sedan
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 år sedan
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 år sedan
requirements.txt 7a9abe3ec5 add chart of version support to version.rst 5 år sedan
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI 5 år sedan
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor 5 år sedan

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.