alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
bcc5bad7b5
esp-idf/docs
History
Ivan Grokhotkov bcc5bad7b5 docs: update download links for OpenOCD 
Point to the latest release on Github, which can now be produced by CI.

Ref. https://github.com/espressif/openocd-esp32/issues/30
Ref. https://github.com/espressif/openocd-esp32/issues/18
2018-04-18 20:58:04 +08:00
..
_static ReadTheDocs theme has an annoying bug of text not being wrapped inside table cells. Each row is extended to fit the text as a single line. For a table with multiple columns and long sentences the table may get wide, with long scrollbar underneath and is not convenient to read. This MR makes the text wrap inside table cells. There is an open PR to fix this issue - https://github.com/rtfd/sphinx_rtd_theme/pull/432. 2018-04-09 05:47:36 +02:00
en docs: update download links for OpenOCD 2018-04-18 20:58:04 +08:00
zh_CN Merge branch 'bugfix/cn_windows_setup_doc_fixes' into 'master' 2018-04-12 16:37:41 +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 ReadTheDocs theme has an annoying bug of text not being wrapped inside table cells. Each row is extended to fit the text as a single line. For a table with multiple columns and long sentences the table may get wide, with long scrollbar underneath and is not convenient to read. This MR makes the text wrap inside table cells. There is an open PR to fix this issue - https://github.com/rtfd/sphinx_rtd_theme/pull/432. 2018-04-09 05:47:36 +02:00
Doxyfile docs: update SDMMC and SDSPI documentation 2018-04-11 11:07:13 +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 docs: speed up incremental builds 2018-03-07 17:45:15 +08:00
local_util.py docs: speed up incremental builds 2018-03-07 17:45:15 +08:00
README.md Restored back original 'zh_CN' version files and updated links between versions 2018-03-13 21:57:08 +01: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 avialable 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

中文