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
b7aea79cb8
esp-idf/docs
History
morris b7aea79cb8 fix(gptimer): hal function placement under wrong condition 
timer_hal_capture_and_get_counter_value
should be placed in the IRAM for speed optimization
because the default ISR handler is placed in the IRAM.

Closes https://github.com/espressif/esp-idf/issues/12021
2023-08-14 02:31:16 +00:00
..
_static fix_error_in_esp32-s2-devkitc-1_pin_layout_diagram 2023-06-08 16:51:09 +08:00
docs_not_updated docs(openthread): update openthread README for H2 and C6 2023-07-12 20:51:58 +08:00
doxygen component/docs: enable generation of API-reference documents for Bluetooth HID host 2023-06-25 15:37:41 +08:00
en fix(gptimer): hal function placement under wrong condition 2023-08-14 02:31:16 +00:00
zh_CN fix(gptimer): hal function placement under wrong condition 2023-08-14 02:31:16 +00: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 component/docs: enable generation of API-reference documents for Bluetooth HID host 2023-06-25 15:37:41 +08:00
doxygen-known-warnings.txt freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS 2022-12-23 15:29:17 +08:00
page_redirects.txt doc: remove left-over legacy event loop docs 2023-03-17 15:37:26 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt heap trace standalone: Fix initialization of the unused linked list, update tests 2023-02-14 09:48:14 +01:00
TEMPLATE_EXAMPLE_README.md docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +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 is built using the python package esp-docs, which can be installed by running pip install esp-docs. Running build-docs --help will give a summary of available options. For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md