esp-idf/docs
Darian Leung 4c57f50fe4 TWAI: ISR runs when cache is disabled
This commit adds the feature where the TWAI ISR will continue to
run even if the cache is disabled. Whilst cache is disabled, any
received messages will go into the RX queue, and any pending TX
messages in the TX queue will be transmitted. This feature should
be enabled using the CONFIG_TWAI_ISR_IN_IRAM option.
2020-10-10 14:19:32 +08:00
..
_static Update docs images 2020-10-09 15:05:01 +08:00
en TWAI: ISR runs when cache is disabled 2020-10-10 14:19:32 +08:00
extensions
idf_extensions build system: Also get IDF version from annotated tags only 2020-10-07 09:36:40 +11:00
latex_templates
test docs: Adds CI tests for the doc building process. 2020-07-28 17:48:19 +08:00
zh_CN Merge branch 'docs/update-images-for-ide' into 'master' 2020-10-09 15:05:06 +08:00
Doxyfile Merge branch 'feature/add_esp_rom_printf_to_api_reference' into 'master' 2020-10-09 04:06:10 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py docs: add warning for doxygen version 2020-09-03 13:48:40 +08:00
check_lang_folder_sync.sh
conf_common.py add chart of version support to version.rst 2020-09-09 11:32:44 +02:00
doxygen-known-warnings.txt
generate_chart.py add chart of version support to version.rst 2020-09-09 11:32:44 +02:00
get_github_rev.py
page_redirects.txt docs: repurpose WROVER-KIT debugging guide for Kaluga-1 2020-07-24 15:54:47 +02:00
requirements.txt add chart of version support to version.rst 2020-09-09 11:32:44 +02:00
sanitize_version.py
sphinx-known-warnings.txt ulp: added support to building code for riscv ULP coprocessor 2020-07-15 15:28:49 -03: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.