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

History

Ivan Grokhotkov 0f515ce3fb docs: make CONTRIBUTING.md readable on Github Move the contents of CONTRIBUTING.rst into contributing/index.rst, create CONTRIBUTING.md with a link to the programming guide. Closes https://github.com/espressif/esp-idf/issues/6807		2022-05-04 01:16:34 +02:00
..
_static	docs: update s3-devkitc-1 user guide	2022-03-29 11:24:20 +08:00
docs_not_updated	freemodbus: remove component files from esp-idf (fix examples)	2022-04-19 07:23:17 +00:00
doxygen	docs: update esp-docs 1.0.0	2022-04-25 12:07:11 +08:00
en	docs: make CONTRIBUTING.md readable on Github	2022-05-04 01:16:34 +02:00
zh_CN	docs: update build system reference and migration guides for lwip	2022-05-02 20:47:18 +02: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: translate coexist from CN to EN	2022-03-09 02:50:00 +00:00
doxygen-known-warnings.txt	docs: Resolve doxygen & Sphinx warnings	2020-02-07 16:37:45 +11:00
page_redirects.txt	docs: add cn trans for system.rst	2022-04-20 13:07:38 +08:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
requirements.txt	docs: update esp-docs 1.0.0	2022-04-25 12:07:11 +08:00
sphinx-known-warnings.txt	docs: update esp-docs 1.0.0	2022-04-25 12:07:11 +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