Historia

Angus Gratton 86148a740b Merge branch 'feature/fatfs_without_wl' into 'master' FATFS support without wear levelling See merge request idf/esp-idf!2526		2018-06-18 12:26:02 +08:00
..
_static	Merge branch 'doc/jtag_startup_command_fix' into 'master'	2018-06-08 15:15:29 +08:00
en	Merge branch 'feature/fatfs_without_wl' into 'master'	2018-06-18 12:26:02 +08:00
zh_CN	docs: add pages about error handling	2018-06-15 15:53:23 +08:00
Doxyfile	docs: add error codes reference	2018-06-15 15:49:24 +08:00
README.md	Fix few typos in the docs	2018-05-03 18:20:16 +05:30
check_doc_warnings.sh	Adjusted CI configuration to handle 'en' and 'zh_CN' language versions	2018-03-13 22:07:31 +01:00
check_lang_folder_sync.sh	Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files	2018-03-16 07:54:58 +01:00
conf_common.py	docs: add error codes reference	2018-06-15 15:49:24 +08:00
gen-dxd.py	Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions	2018-03-13 22:07:31 +01:00
gen-kconfig-doc.py	Kconfig: split out compiler options, add them to reference	2018-06-15 15:49:23 +08:00
issue_template.md	add github issue template for users to report issues easily	2018-04-16 08:16:13 +00:00
kconfiglib.py	Fail CI build on Sphinx warnings	2017-09-12 07:12:57 +02:00
link-roles.py	Implemented docutils custom role that renders a link to current documentation page on Read The Docs in another language version	2018-05-21 10:30:07 +08:00
local_util.py	docs: speed up incremental builds	2018-03-07 17:45:15 +08:00
requirements.txt	docs : Add support for markdown files	2018-01-15 13:58:31 +08:00
sphinx-known-warnings.txt	Upgraded Sphinx to latest release 1.6.5 that contains a fix to https://github.com/sphinx-doc/sphinx/issues/4041 . Upgraded Breathe to latest release 4.7.3 as well.	2017-10-31 22:57:39 +01: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:

English

Main server: https://esp-idf.readthedocs.io/en/latest/ or http://esp-idf.readthedocs.io/en/latest/
Mirror: https://espressif-docs.readthedocs-hosted.com/projects/esp-idf/en/latest/
Latest docs mirror: https://dl.espressif.com/doc/esp-idf/latest/