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
2f73a62737
esp-idf/docs
History
krzychb 2f73a62737 docs: Upgraded sphinx package version to prevent build failures on readthedocs site. Upgraded versions of other packages that are used during documentation build. (backport v3.1)
2019-03-19 20:09:30 +01:00
..
_static docs/rewrite_mesh_docs 2018-09-03 13:03:32 +08:00
en Merge branch 'bugfix/doc_ubuntu_packages_v3.1' into 'release/v3.1' 2019-03-17 14:41:44 +08:00
zh_CN docs: Update package dependencies 2019-03-11 10:20:36 +01:00
check_doc_warnings.sh docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs. (backport v3.1) 2019-02-27 23:36:34 +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 Merge branch 'release/v3.1' into feature/cmake_v3.1 2018-08-17 14:14:10 +10:00
docs_common.mk docs: Move version-related includes to run in sphinx-build not make 2018-08-13 16:01:20 +10:00
Doxyfile esp_https_ota: Add support for HTTPS based ota feature 2018-08-08 14:55:22 +05:30
gen-dxd.py Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions 2018-03-13 22:07:31 +01:00
gen-version-specific-includes.py docs: Move version-related includes to run in sphinx-build not make 2018-08-13 16:01:20 +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 docs: Switch base URL from esp-idf.readthedocs.io to docs.espressif.com 2018-06-19 11:23:33 +00:00
requirements.txt docs: Upgraded sphinx package version to prevent build failures on readthedocs site. Upgraded versions of other packages that are used during documentation build. (backport v3.1) 2019-03-19 20:09:30 +01:00
sphinx-known-warnings.txt docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs. (backport v3.1) 2019-02-27 23:36:34 +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:

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.