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

History

Shang Zhou be389496e1 docs: sync up CN and EN versions for build-system and partition-tables		2022-09-09 18:28:41 +08:00
..
_static	Docs: update figures for esp32-s3-devkitc-1 user guide	2022-08-31 16:24:58 +08:00
docs_not_updated	update doc for esp32c2	2022-09-07 15:18:45 +08:00
doxygen	Merge branch 'feature/ulp_mutex' into 'master'	2022-08-21 16:27:53 +08:00
en	docs: sync up CN and EN versions for build-system and partition-tables	2022-09-09 18:28:41 +08:00
zh_CN	docs: sync up CN and EN versions for build-system and partition-tables	2022-09-09 18:28:41 +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	Merge branch 'docs/update_linkcheck_ignore_c2' into 'master'	2022-08-21 16:28:31 +08:00
doxygen-known-warnings.txt	docs: fix all doxygen warnings	2022-05-12 14:50:03 +08:00
page_redirects.txt	docs: update the link to redirect chip-series-comparison.rst	2022-08-18 08:09:51 +00:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +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