History

Angus Gratton 1abd346943 docs: Call 'python -m sphinx' instead of sphinx-build Fixes mismatches where default Python interpreter may not match the most recently installed sphinx-build wrapper script (if sphinx 2 & 3 both installed, pip will clobber any previous copy of /bin/sphinx-build when it installs the new one.)		2018-08-29 14:43:42 +08:00
..
_static	Replaced Espressif logo with a new, consistent, modern and neutral typeface design.	2018-08-13 07:22:41 +02:00
en	docs: Adds description of OpenOCD command to configure custom app image location	2018-08-27 14:08:36 +03:00
zh_CN	doc: additional translation in get_stated	2018-08-27 10:44:28 +08:00
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	Merge branch 'docs/simplified_rtd_theme_configuration' into 'master'	2018-08-16 05:23:54 +08:00
docs_common.mk	docs: Call 'python -m sphinx' instead of sphinx-build	2018-08-29 14:43:42 +08:00
Doxyfile	docs: add API reference section for esp_system.h	2018-08-20 16:49:20 +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
gen-version-specific-includes.py	docs: Move version-related includes to run in sphinx-build not make	2018-08-13 12:24:55 +10:00
issue_template.md	docs: Switch base URL from esp-idf.readthedocs.io to docs.espressif.com	2018-06-19 11:23:33 +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
README.md	Replace all DOS line endings with Unix	2018-07-12 19:10:37 +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
TEMPLATE_EXAMPLE_README.md	docs: Add "Creating Examples" docs page, template example README	2018-06-14 16:49:22 +10: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.