esp-idf/docs
Krzysztof Budzynski de1f56466b Merge branch 'bugfix/doc_redirects' into 'master'
doc: Create redirects for ESP32 hw-reference get-started URLs

Closes IDF-1503

See merge request espressif/esp-idf!8094
2020-03-25 17:34:19 +08:00
..
_static
en
extensions
idf_extensions
zh_CN
Doxyfile
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py
check_lang_folder_sync.sh
conf_common.py
doxygen-known-warnings.txt
page_redirects.txt
requirements.txt
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.