mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00

History

Sudeep Mohanty 52050ed883 freertos: added doxygen section tags for conditional documentation Added DOC_EXCLUDE_SECTION section tag to conditionally remove sections from FreeRTOS source files which we don't want in IDF API docs. Added DOC_SINGLE_GROUP section tag to enable a flat document for FreeRTOS and removing groups. With these conditional tags, we can upstream FreeRTOS files without affecting the upstream documentation. Signed-off-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>		2021-10-11 09:24:41 +05:30
..
_static	docs/update_esp32-s2_devkit_user_guides	2021-09-22 14:59:06 +08:00
doxygen	freertos: added doxygen section tags for conditional documentation	2021-10-11 09:24:41 +05:30
en	openssl: Add deprecation warning to ssl.h	2021-10-05 11:45:52 +02:00
zh_CN	Merge branch 'docs/update_CN_trans_i2c_ledc' into 'master'	2021-09-23 18:13:54 +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	docs: enable publishing of S3 docs	2021-09-06 09:11:17 +08:00
doxygen-known-warnings.txt	docs: Resolve doxygen & Sphinx warnings	2020-02-07 16:37:45 +11:00
generate_chart.py	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
page_redirects.txt	doc: update tinyusb document to support esp32s3	2021-07-22 10:43:10 +08:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
requirements.txt	docs: bump esp-docs version to 0.1.1	2021-09-06 14:55:04 +08:00
sphinx-known-warnings.txt	docs: ignore duplicate def warning in BT docs	2021-06-30 15:10:43 +08:00
TEMPLATE_EXAMPLE_README.md	examples: Update system examples README	2019-08-28 16:19:40 +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