History

Krzysztof Budzynski 412c43d9b9 Merge branch 'docs/saola-1-guide' into 'master' Add links to translation in Saola board user guide See merge request espressif/esp-idf!8124		2020-04-15 22:23:27 +08:00
..
_static	add Ethernet doc	2020-03-26 11:04:55 +00:00
en	Add links to translation in Saola board user guide	2020-04-15 22:23:26 +08:00
extensions	doc: custom list filter directive	2020-02-20 18:08:05 +08:00
idf_extensions	doc: fix defines dict expansion	2020-03-30 18:26:37 +08:00
zh_CN	Merge branch 'docs/saola-1-guide' into 'master'	2020-04-15 22:23:27 +08:00
build_docs.py	docs: deploy docs to production server from CI	2020-03-16 14:36:23 +11:00
check_lang_folder_sync.sh	global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs	2020-04-03 01:10:02 +02:00
conf_common.py	docs: update esp32s2 summary page	2020-03-16 14:40:37 +11:00
Doxyfile	driver(adc/dac): fix adc dac driver for esp32s2	2020-04-01 12:41:51 +08:00
doxygen-known-warnings.txt	docs: Resolve doxygen & Sphinx warnings	2020-02-07 16:37:45 +11:00
page_redirects.txt	doc: Create redirects for ESP32 hw-reference get-started URLs	2020-03-24 14:56:12 +11:00
README.md	docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer	2020-03-16 14:36:23 +11:00
requirements.txt	docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer	2020-03-16 14:36:23 +11:00
sanitize_version.py	docs: deploy docs to production server from CI	2020-03-16 14:36:23 +11:00
sphinx-known-warnings.txt	docs: Resolve doxygen & Sphinx warnings	2020-02-07 16:37:45 +11:00
TEMPLATE_EXAMPLE_README.md	examples: Update system examples README	2019-08-28 16:19:40 +08:00

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.