Files

Ivan Grokhotkov c03dff473b Merge branch 'docs/make_core_dump_doc_clear' into 'master'

docs: Makes core dump's documentation slightly clearer

See merge request idf/esp-idf!2433

2018-05-24 17:38:28 +08:00

_static

Merge branch 'feature/xRingBufferCanRead_pr1672' into 'master'

2018-05-23 15:09:40 +08:00

Merge branch 'docs/make_core_dump_doc_clear' into 'master'

2018-05-24 17:38:28 +08:00

zh_CN

Merge branch 'feature/xRingBufferCanRead_pr1672' into 'master'

2018-05-23 15:09:40 +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

docs: make conf.py python3 compatible

2018-05-04 02:31:57 +08:00

Doxyfile

Merge branch 'feature/proto-client' into 'master'

2018-05-22 21:06:46 +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

Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions

2018-03-13 22:07:31 +01: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

README.md

Fix few typos in the docs

2018-05-03 18:20:16 +05:30

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/