mirror of https://github.com/espressif/esp-idf.git synced 2026-02-08 08:44:50 +00:00

Files

Angus Gratton a1fac97f1a cmake: Fix set_default using value from environment

Fixes issue with idf.py passing through Python interpreter, as reported in
https://github.com/espressif/esp-idf/issues/1924

2018-05-29 16:34:45 +10: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

cmake: Fix set_default using value from environment

2018-05-29 16:34:45 +10:00

zh_CN

docs: Move main docs to cover CMake

2018-05-07 18:45:49 +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

Revert "docs: Temporarily allow cmake docs to be in English only"

2018-05-07 18:45:49 +08:00

conf_common.py

doc: Use confgen.py to build docs from same code path as config generation

2018-04-30 09:59:20 +10:00

Doxyfile

component/bt : modify header files to avoid conflict

2018-04-26 19:32:06 +08:00

gen-dxd.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

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/