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
fe11add262
esp-idf/docs
History
Darian Leung fe11add262 freertos: Rename SMP changes document to ESP-IDF FreeRTOS 
This commit renames "freertos-smp" docuemnt to "freertos_idf". This fits better
with the current dual FreeRTOS implementation (i.e., IDF FreeRTOS and Amazon
SMP FreeRTOS), both of which are SMP capable.
2023-02-17 20:43:30 +08:00
..
_static Merge branch 'docs/update_index_v5.0' into 'release/v5.0' 2022-12-02 19:32:58 +08:00
docs_not_updated WDT: implement interrupt wdt and task wdt for ESP32-C2 2022-12-01 10:45:35 +00:00
doxygen Merge branch 'feature/apply_new_version_logic_v5.0' into 'release/v5.0' 2023-01-12 16:18:23 +08:00
en freertos: Rename SMP changes document to ESP-IDF FreeRTOS 2023-02-17 20:43:30 +08:00
zh_CN freertos: Rename SMP changes document to ESP-IDF FreeRTOS 2023-02-17 20:43:30 +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 tools: cmake: check tool supported version with idf_tools.py 2022-10-18 12:27:55 +04:00
doxygen-known-warnings.txt docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
page_redirects.txt freertos: Rename SMP changes document to ESP-IDF FreeRTOS 2023-02-17 20:43:30 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt fatfs: Add mock option to ff_sdmmc_status function to increase IO speed 2022-06-09 20:09:32 +00: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