Angus Gratton d02a9bddf2 docs: Update Versions file in line with the latest Support Policy document		vor 5 Jahren
..
_static	5773767b81 Provide getting started guide for ESP32-Ethernet-Kit-V1.2 based on V1.1	vor 5 Jahren
en	d02a9bddf2 docs: Update Versions file in line with the latest Support Policy document	vor 5 Jahren
extensions	63b76a9d90 doc: custom list filter directive	vor 6 Jahren
idf_extensions	b529b757aa doc: fall back to CI_COMMIT_REF_NAME as a branch name	vor 5 Jahren
latex_templates	407275f681 doc: add latex and PDF generation to build_docs	vor 5 Jahren
test	ba546a0d91 docs: Adds CI tests for the doc building process.	vor 5 Jahren
zh_CN	d02a9bddf2 docs: Update Versions file in line with the latest Support Policy document	vor 5 Jahren
Doxyfile	b30522f701 esp32, esp32s2: move sleep modes code to esp_system	vor 5 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	d02a9bddf2 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 5 Jahren
conf_common.py	b30bd7a2ef esp32s2: add CP_DMA driver	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 5 Jahren
page_redirects.txt	962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1	vor 5 Jahren
requirements.txt	ccdd3d3db8 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	b6dba84323 ulp: added support to building code for riscv ULP coprocessor	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