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
826cc7ecb6
esp-idf/docs
History
Michael (XIAO Xufeng) 826cc7ecb6 Merge branch 'feature/bringup_723_cmake_rmt_driver_update' into 'master' 
RMT new features in ESP32S2

Closes IDF-1286

See merge request espressif/esp-idf!7401
2020-03-26 10:24:18 +08:00
..
_static Updated index 2020-03-11 06:43:31 +08:00
en Merge branch 'feature/bringup_723_cmake_rmt_driver_update' into 'master' 2020-03-26 10:24:18 +08:00
extensions doc: custom list filter directive 2020-02-20 18:08:05 +08:00
idf_extensions docs: Fix generation of links to examples 2020-03-23 18:11:23 +11:00
zh_CN Add translation for linker script generation 2020-03-26 00:48:58 +08:00
build_docs.py docs: deploy docs to production server from CI 2020-03-16 14:36:23 +11:00
check_lang_folder_sync.sh Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files 2018-03-16 07:54:58 +01:00
conf_common.py docs: update esp32s2 summary page 2020-03-16 14:40:37 +11:00
Doxyfile docs: Fix broken URLs & permanent redirects 2020-03-23 18:11:23 +11:00
doxygen-known-warnings.txt docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
page_redirects.txt doc: Create redirects for ESP32 hw-reference get-started URLs 2020-03-24 14:56:12 +11:00
README.md docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 2020-03-16 14:36:23 +11:00
requirements.txt docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 2020-03-16 14:36:23 +11:00
sanitize_version.py docs: deploy docs to production server from CI 2020-03-16 14:36:23 +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

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.