Home Explore Help
Sign In
RT-Thread-packages
/
esp-idf
mirror of https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: c54e9d9d5c
Branches Tags
esp-idf
/
docs
Marius Vikhammer c54e9d9d5c build_docs: fix incorrect arguments for linkcheck 5 years ago
..
_static 97721d469c TWAI: Add ESP32-S2 support 5 years ago
en 0cca898e19 docs: change redirection link in get-started 5 years ago
extensions 63b76a9d90 doc: custom list filter directive 6 years ago
idf_extensions 32761b9782 docs: fix link_roles not linking correctly for certain files 5 years ago
latex_templates 407275f681 doc: add latex and PDF generation to build_docs 5 years ago
zh_CN 0cca898e19 docs: change redirection link in get-started 5 years ago
Doxyfile b6dba84323 ulp: added support to building code for riscv ULP coprocessor 5 years ago
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 years ago
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 years ago
build_docs.py c54e9d9d5c build_docs: fix incorrect arguments for linkcheck 5 years ago
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 years ago
conf_common.py b6dba84323 ulp: added support to building code for riscv ULP coprocessor 5 years ago
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 years ago
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 years ago
page_redirects.txt 97721d469c TWAI: Add ESP32-S2 support 5 years ago
requirements.txt ccdd3d3db8 docs: update sphinx_idf_theme documentation 5 years ago
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI 5 years ago
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor 5 years ago

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.