esp-idf/docs
Krzysztof Budzynski 0842aed2bc Merge branch 'doc/submodule_links' into 'master'
doc: roles for linking files now correctly links to submodule repositories

Closes IDF-1584

See merge request espressif/esp-idf!8405
2020-04-22 01:49:18 +08:00
..
_static doc: add latex and PDF generation to build_docs 2020-04-15 17:14:22 +08:00
en Merge branch 'doc/submodule_links' into 'master' 2020-04-22 01:49:18 +08:00
extensions
idf_extensions doc: roles for linking files now correctly links to submodule repositories 2020-04-20 15:59:41 +08:00
latex_templates doc: add latex and PDF generation to build_docs 2020-04-15 17:14:22 +08:00
zh_CN Merge branch 'docs/saola-1-guide' into 'master' 2020-04-15 22:23:27 +08:00
Doxyfile driver(adc/dac): fix adc dac driver for esp32s2 2020-04-01 12:41:51 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py doc: add latex and PDF generation to build_docs 2020-04-15 17:14:22 +08: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 doc: add latex and PDF generation to build_docs 2020-04-15 17:14:22 +08:00
doxygen-known-warnings.txt
page_redirects.txt doc: Create redirects for ESP32 hw-reference get-started URLs 2020-03-24 14:56:12 +11:00
requirements.txt doc: update CI to build PDF 2020-04-15 17:14:27 +08:00
sanitize_version.py
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

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.