esp-idf/docs
Michael (XIAO Xufeng) 65fff4dbf3 Merge branch 'docs/remove_docs_of_non_existent_limitation' into 'master'
docs: remove no longer existent limitation of spi slave

Closes IDF-1916

See merge request espressif/esp-idf!10111
2020-08-29 23:12:45 +08:00
..
_static Provide getting started guide for ESP32-Ethernet-Kit-V1.2 based on V1.1 2020-07-28 13:49:33 +08:00
en Merge branch 'docs/remove_docs_of_non_existent_limitation' into 'master' 2020-08-29 23:12:45 +08:00
extensions
idf_extensions docs: fix version specific note on local build 2020-08-21 09:24:41 +00:00
latex_templates
test docs: Adds CI tests for the doc building process. 2020-07-28 17:48:19 +08:00
zh_CN Merge branch 'bugfix/get_started_inconsistency' into 'master' 2020-08-28 20:23:17 +08:00
Doxyfile esp32, esp32s2: move sleep modes code to esp_system 2020-08-17 19:09:23 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py docs: adds to build_docs.py an encoding check suitable for windows 2020-08-11 13:52:21 +02:00
check_lang_folder_sync.sh
conf_common.py Docs: Add copybutton package to conf_common.py 2020-08-27 02:48:43 +00:00
doxygen-known-warnings.txt
get_github_rev.py docs: add 'edit-on-github' link to html theme 2020-05-06 17:25:23 +08:00
page_redirects.txt docs: repurpose WROVER-KIT debugging guide for Kaluga-1 2020-07-24 15:54:47 +02:00
requirements.txt docs: update sphinx_idf_theme documentation 2020-07-06 10:45:43 +08:00
sanitize_version.py
sphinx-known-warnings.txt ulp: added support to building code for riscv ULP coprocessor 2020-07-15 15:28:49 -03: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.