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
a5bf40b495
esp-idf/docs
History
David Čermák 1d3dbb239a Merge branch 'feature/ws_server' into 'master' 
http_server: adds WebSocket support

Closes IDFGH-2151 and IDFGH-2752

See merge request espressif/esp-idf!7893
2020-03-19 17:20:56 +08:00
..
_static Updated index 2020-03-11 06:43:31 +08:00
en Merge branch 'feature/ws_server' into 'master' 2020-03-19 17:20:56 +08:00
extensions doc: custom list filter directive 2020-02-20 18:08:05 +08:00
idf_extensions docs: Update link_to_translation to work with targets & new URL scheme 2020-03-16 14:36:23 +11:00
zh_CN Merge branch 'refactor/common_code_panic_handler' into 'master' 2020-03-19 11:23:57 +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 Revert "docs: Temporarily allow cmake docs to be in English only" 2018-05-07 18:45:49 +08:00
conf_common.py docs: update esp32s2 summary page 2020-03-16 14:40:37 +11:00
Doxyfile Merge branch 'refactor/common_code_panic_handler' into 'master' 2020-03-19 11:23:57 +08:00
doxygen-known-warnings.txt docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
page_redirects.txt feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 2020-02-25 01:28:22 +05:30
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.