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
7c6a39ed2e
esp-idf/docs
History
Guillaume Souchere 7c6a39ed2e esp_system: Add esp_cpu.h migration guide 
This commit:
- adds the migration guide for migrating from the now deprecated cpu_hal/ll.h,
  soc_hal/ll.h, and interrupt_controller_hal.h to esp_cpu.h.
- adds the migration guide for migrating from the now deleted compare_set.h header file.
- adds the migration guide for migrating from the now deleted esp_cpu_get_ccount(),
  esp_cpu_set_ccount() and esp_cpu_in_ocd_debug_mode() functions in esp_cpu.h.
2022-07-22 00:06:06 +08:00
..
_static i2s: add slot sequence table 2022-07-21 15:52:39 +08:00
docs_not_updated docs: update JTAG related information for ESP32-C2 2022-07-14 15:57:43 +02:00
doxygen doc: update sdm api reference 2022-07-20 14:59:50 +08:00
en esp_system: Add esp_cpu.h migration guide 2022-07-22 00:06:06 +08:00
zh_CN Merge branch 'bugfix/further_fix_for_mspi_current_leakage' into 'master' 2022-07-21 19:14:26 +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 doc: update sdm api reference 2022-07-20 14:59:50 +08:00
doxygen-known-warnings.txt docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
page_redirects.txt doc: update sdm api reference 2022-07-20 14:59:50 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
requirements.txt docs: fix all doxygen warnings 2022-05-12 14:50:03 +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