Renz Bagaporo 79887fdc6c soc: descriptive part occupy whole component		5 年之前
..
_static	ba901179fe Update docs images	5 年之前
en	79887fdc6c soc: descriptive part occupy whole component	5 年之前
extensions	63b76a9d90 doc: custom list filter directive	6 年之前
idf_extensions	79887fdc6c soc: descriptive part occupy whole component	5 年之前
latex_templates	407275f681 doc: add latex and PDF generation to build_docs	5 年之前
test	ba546a0d91 docs: Adds CI tests for the doc building process.	5 年之前
zh_CN	79887fdc6c soc: descriptive part occupy whole component	5 年之前
Doxyfile	988be69466 esp_hw_support: create component	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	91cf7cc58d doc: dedicated gpio api reference	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 年之前

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