esp-idf/docs
Sudeep Mohanty 4846222102 freertos: update freertos folder structure to match upstream
The following changes have been made:
1. All FreeRTOS kernel source files are now placed in the
   freertos/FreeRTOS-Kernel folder to match with the upstream folder structure.
2. All kernel include files are now placed in freertos/FreeRTOS-Kernel/include.
3. All port files are now placed in freertos/FreeRTOS-Kernel/portable.
4. All additions/customizations are placed in freertos/esp_additions.
5. All other miscellaneous files (README, License files etc.) are moved to
   freertos/FreeRTOS-Kernel folder to match with the upstream.
6. Updated esp-cryptoauthlib to latest commit to resolve FreeRTOS
   include dependencies.

Signed-off-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>
2021-10-29 12:05:13 +08:00
..
_static docs: replace the module on esp32-devkitc from esp32-wrover to esp32-wroom 2021-10-28 17:29:17 +08:00
doxygen freertos: update freertos folder structure to match upstream 2021-10-29 12:05:13 +08:00
en freertos: update freertos folder structure to match upstream 2021-10-29 12:05:13 +08:00
zh_CN Merge branch 'doc/make_classic_bt_API_ref_only_for_esp32' into 'master' 2021-10-29 02:27:24 +00:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py Merge branch 'doc/make_classic_bt_API_ref_only_for_esp32' into 'master' 2021-10-29 02:27:24 +00:00
doxygen-known-warnings.txt
generate_chart.py
page_redirects.txt
requirements.txt docs: bump esp-docs version to 0.1.1 2021-09-06 14:55:04 +08:00
sphinx-known-warnings.txt

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