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

History

Dai Zi Yan 8c23e4ebab Merge branch 'docs/update_CN_trans_memory_type' into 'master' docs: updated CN trans for memory-types Closes DOC-2347 See merge request espressif/esp-idf!16370		2022-01-10 03:31:32 +00:00
..
_static	usb: Add USB Host Library documentation	2022-01-06 15:15:32 +08:00
docs_not_updated	Merge branch 'docs/esp8684_frontpages' into 'master'	2022-01-04 08:47:42 +00:00
doxygen	doc: API reference for GPTimer	2022-01-07 14:59:09 +08:00
en	Merge branch 'docs/update_CN_trans_memory_type' into 'master'	2022-01-10 03:31:32 +00:00
zh_CN	docs: updated CN trans for memory-types and external-ram	2022-01-08 15:21:17 +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: fix missing static file path	2021-12-29 13:57:30 +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: update docs to be able to build with esp8684	2021-12-20 10:32:49 +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	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