Vikram Dattu f278db260e esp_local_ctrl: Added documentation to chose protocom security		vor 4 Jahren
..
_static	d5eea66bbb docs/update_esp32-s2_devkit_user_guides	vor 4 Jahren
en	f278db260e esp_local_ctrl: Added documentation to chose protocom security	vor 4 Jahren
extensions	63b76a9d90 doc: custom list filter directive	vor 6 Jahren
idf_extensions	2e469b52ae build system: Also get IDF version from annotated tags only	vor 5 Jahren
latex_templates	407275f681 doc: add latex and PDF generation to build_docs	vor 6 Jahren
zh_CN	8eca11af23 Merge branch 'docs/update_esp32-s2_devkit_user_guide_backport_v4.2' into 'release/v4.2'	vor 4 Jahren
Doxyfile	86c5d3136e docs: define __DOXYGEN__ for doxygen builds	vor 4 Jahren
README.md	416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer	vor 6 Jahren
TEMPLATE_EXAMPLE_README.md	de682a13b1 examples: Update system examples README	vor 6 Jahren
build_docs.py	dbdb1c1c23 docs: Update Versions file in line with the latest Support Policy document	vor 5 Jahren
check_lang_folder_sync.sh	e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs	vor 6 Jahren
conf_common.py	5d88861dba docs: add RF calibration docs for ESP32-S2	vor 5 Jahren
doxygen-known-warnings.txt	11fac8637a docs: Resolve doxygen & Sphinx warnings	vor 6 Jahren
get_github_rev.py	214f1fbbed docs: add 'edit-on-github' link to html theme	vor 6 Jahren
page_redirects.txt	ead33e155d docs: repurpose WROVER-KIT debugging guide for Kaluga-1	vor 5 Jahren
requirements.txt	61904135b3 docs: update sphinx_idf_theme documentation	vor 5 Jahren
sanitize_version.py	1a2ddcb77a docs: deploy docs to production server from CI	vor 6 Jahren
sphinx-known-warnings.txt	302a43562d docs: fix check_docs not working for multiple builders	vor 5 Jahren

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.

README.md

Documentation Source Folder

Hosted Documentation

Building Documentation