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

History

Marius Vikhammer e07d16d6a3 docs: update linkcheck configs linkcheck CI job can now pass, no longer necessary to ignore the results from it.		2022-07-04 11:05:49 +08:00
..
_static	docs: fix missing static file path	2022-03-03 10:48:20 +08:00
doxygen	docs: update esp-docs 1.0.0	2022-07-04 11:05:49 +08:00
en	docs: fix broken links	2022-07-04 11:05:49 +08:00
zh_CN	docs: fix broken links	2022-07-04 11:05:49 +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: update linkcheck configs	2022-07-04 11:05:49 +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	ulp: Added support for ULP FSM on esp32s3 and fixed bugs for esp32s2	2022-06-29 11:57:02 +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-07-04 11:05:49 +08:00
sphinx-known-warnings.txt	docs: update esp-docs 1.0.0	2022-07-04 11:05:49 +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