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
ea78d06939
esp-idf/docs
History
Angus Gratton 084e170a8f Merge branch 'refactor/esp_ipc' into 'master' 
Split esp_ipc to a seaparate component

Closes IDF-1295

See merge request espressif/esp-idf!8520
2020-05-25 15:03:04 +08:00
..
_static docs: Provide link to ESP32-S2 specific documentation 2020-05-25 02:59:36 +08:00
en Merge branch 'bugfix/fix_i2s_comm_format_unclear_description_bug' into 'master' 2020-05-25 15:00:10 +08:00
extensions doc: custom list filter directive 2020-02-20 18:08:05 +08:00
idf_extensions Merge branch 'doc/view_github_link' into 'master' 2020-05-25 03:21:23 +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 'doc/add_types_api_ref' into 'master' 2020-05-25 03:22:22 +08:00
build_docs.py docs: support building a subset of the documentation with build_docs 2020-05-22 15:01:40 +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 Merge branch 'doc/view_github_link' into 'master' 2020-05-25 03:21:23 +08:00
Doxyfile esp_ipc: Move to new component 2020-05-18 16:51:45 +08:00
doxygen-known-warnings.txt docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
get_github_rev.py docs: add 'edit-on-github' link to html theme 2020-05-06 17:25:23 +08:00
page_redirects.txt Add redirect link from user-guide-kaluga-1-v1.2 to user-guide-esp32-s2-kaluga-1-kit 2020-05-18 17:28:03 +08: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 doc: update CI to build PDF 2020-04-15 17:14:27 +08: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.