Aditya Patwardhan ca964dfbcc esp-tls: Changed default behaviour for esp-tls client ( for security пре 5 година
..
_static 703aef654b provide user guide for ESP32-DevKitM-1 пре 5 година
doxygen da947d736f Docs: Add C3 support to build_docs пре 5 година
en ca964dfbcc esp-tls: Changed default behaviour for esp-tls client ( for security пре 5 година
extensions 63b76a9d90 doc: custom list filter directive пре 6 година
idf_extensions da947d736f Docs: Add C3 support to build_docs пре 5 година
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) пре 5 година
test ba546a0d91 docs: Adds CI tests for the doc building process. пре 5 година
zh_CN 703aef654b provide user guide for ESP32-DevKitM-1 пре 5 година
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer пре 5 година
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README пре 6 година
build_docs.py 9b552ce004 docs: add warning for doxygen version пре 5 година
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs пре 5 година
conf_common.py da947d736f Docs: Add C3 support to build_docs пре 5 година
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings пре 6 година
generate_chart.py 7a9abe3ec5 add chart of version support to version.rst пре 5 година
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme пре 5 година
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 пре 5 година
requirements.txt 7a9abe3ec5 add chart of version support to version.rst пре 5 година
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI пре 5 година
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor пре 5 година

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.