mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

Marius Vikhammer 3c9f94d739 Merge branch 'feature/publish_s3_docs' into 'master' docs: enable publishing of S3 docs Closes IDF-3385 and IDF-3285 See merge request espressif/esp-idf!15074		2021-09-07 03:30:36 +00:00
..
_static	freemodbus: update the modbus documentation doc-1641	2021-09-05 21:01:07 +02:00
doxygen	Merge branch 'feature/esp_ds_s3' into 'master'	2021-09-03 07:57:26 +00:00
en	freertos: upgrade to 10.4.3 - missing files from upstream	2021-09-06 14:39:48 +08:00
zh_CN	updated the TOC of ESP-IDF API Reference to make it consistet with the real section title	2021-09-03 16:27:14 +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	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