alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
20d93ac835
esp-idf/docs
History
Ivan Grokhotkov 20d93ac835 docs: remove note about v4.0 docker tag, use release-v4.0 as example
2020-02-18 14:02:46 +01:00
..
_static docs: add API guide page about IDF Tools 2020-01-24 14:02:21 +01:00
en docs: remove note about v4.0 docker tag, use release-v4.0 as example 2020-02-18 14:02:46 +01:00
extensions doc: Changed toc filter reg.ex to be non-greedy 2020-02-07 16:37:43 +11:00
idf_extensions docs: Check local files exist (and are correct type) for custom link roles 2020-02-18 10:34:11 +11:00
zh_CN Merge branch 'bugfix/use_quotes_in_embedding_ulp_apps' into 'master' 2020-02-18 09:15:50 +08:00
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 Revert "docs: Temporarily allow cmake docs to be in English only" 2018-05-07 18:45:49 +08:00
conf_common.py docs: Move to Python 3.5+ and Sphinx 2.3 2020-02-07 16:47:50 +11:00
Doxyfile soc: separate abstraction, description and implementation 2020-02-11 14:30:42 +05:00
doxygen-known-warnings.txt docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
page_redirects.txt esp_netif: docs update to include tcpip_adapter migration guide 2019-11-25 08:32:11 +01:00
README.md docs: Move to Python 3.5+ and Sphinx 2.3 2020-02-07 16:47:50 +11:00
requirements.txt docs: Move to Python 3.5+ and Sphinx 2.3 2020-02-07 16:47:50 +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

  • 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.