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
56d5647d3f
esp-idf/docs
History
krzychb 56d5647d3f Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions
2018-03-13 22:07:31 +01:00
..
_static esp_adc_cal/Add eFuse functionality 2018-02-13 21:22:48 +08:00
api-guides Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available 2018-03-13 21:57:08 +01:00
en Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions 2018-03-13 22:07:31 +01:00
zh_CN Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions 2018-03-13 22:07:31 +01:00
check_doc_warnings.sh ci: Add new check_doc_warnings.sh script, pre-process log lines 2017-09-14 13:46:35 +10:00
Doxyfile Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version 2018-03-13 21:57:08 +01: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
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

中文