esp-idf/docs
Krzysztof Budzynski 41bc06b9b9 Merge branch 'bugfix/docs_ledc' into 'master'
drivers: Remove high speed mode from LEDC docs for ESP32-S2, update headers to match

See merge request espressif/esp-idf!7532
2020-02-17 05:00:36 +08:00
..
_static
en Merge branch 'bugfix/docs_ledc' into 'master' 2020-02-17 05:00:36 +08:00
extensions
idf_extensions bugfix/build_docs_add_warning_check: Added null value check for warnings 2020-02-12 12:32:41 +05:30
zh_CN docs: Add Chinese translation for esp-ble-mesh-faq 2020-02-17 04:58:56 +08:00
Doxyfile soc: separate abstraction, description and implementation 2020-02-11 14:30:42 +05:00
README.md docs: Move to Python 3.5+ and Sphinx 2.3 2020-02-07 16:47:50 +11:00
TEMPLATE_EXAMPLE_README.md
build_docs.py bugfix/build_docs_add_warning_check: Added null value check for warnings 2020-02-12 12:32:41 +05:30
check_lang_folder_sync.sh
conf_common.py docs: Move to Python 3.5+ and Sphinx 2.3 2020-02-07 16:47:50 +11:00
doxygen-known-warnings.txt
page_redirects.txt
requirements.txt docs: Move to Python 3.5+ and Sphinx 2.3 2020-02-07 16:47:50 +11:00
sphinx-known-warnings.txt

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

  • Documentation build requres Python 3 and will not work with Python 2
  • Install dependencies for ESP-IDF as per the Getting Started guide
  • Install documentation Python depdendencies, ie pip install -r $IDF_PATH/docs/requirements.txt
  • Run ./build_docs.py build to build docs for all supported Language & Target combinations, or ./build_docs.py -t esp32 -l en build to build docs for a single supported language & target combination only.

See Documenting Code for more information.

Available languages are en and zh_CN, targets are any target supported by ESP-IDF - for example esp32 or esp32s2.