blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-10 09:39:10 -04:00
Code Issues Projects Releases Wiki Activity
esp-idf/docs
History
Ivan Grokhotkov 8e6d450a8c Revert "Merge branch 'feature/gdb_stub_task_state' into 'master'" 
This reverts commit c41a0c1907dec7cdc0d99e7ed8273cd6ea6f6c7f, reversing
changes made to 5c1d317766cf8be9490d0b3b51c0fd060985fad9.
2020-07-09 17:16:47 +02:00
..
_static
TWAI: Add ESP32-S2 support
2020-06-30 16:56:03 +08:00
en
Revert "Merge branch 'feature/gdb_stub_task_state' into 'master'"
2020-07-09 17:16:47 +02:00
extensions
doc: custom list filter directive
2020-02-20 18:08:05 +08:00
idf_extensions
docs: fix link_roles not linking correctly for certain files
2020-06-22 20:42:59 +08:00
latex_templates
doc: add latex and PDF generation to build_docs
2020-04-15 17:14:22 +08:00
zh_CN
console_repl: change config structure to support different devices
2020-07-02 07:39:46 +00:00
build_docs.py
docs: fix check_docs not working for multiple builders
2020-05-29 20:10:18 +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
docs: add section about USB CDC console
2020-06-26 15:38:49 +02:00
Doxyfile
TWAI: Add ESP32-S2 support
2020-06-30 16:56:03 +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
TWAI: Add ESP32-S2 support
2020-06-30 16:56: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
docs: update sphinx_idf_theme documentation
2020-07-06 10:45:43 +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: fix check_docs not working for multiple builders
2020-05-29 20:10:18 +08: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.