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
91f579d714
esp-idf/docs
History
Roland Dobai c3d99dd2e4 Encourage to install python packages without administrative rights 
Using 'sudo pip install' can cause a lot of problems because usually
there are a couple of Python interpreters installed. This fix encourages
developers to use `pip install --user` instead which is safer.
2018-09-11 08:54:37 +02:00
..
_static Merge branch 'feature/esp-wrover-kit-v4_1' into 'master' 2018-09-10 14:48:41 +08:00
en Encourage to install python packages without administrative rights 2018-09-11 08:54:37 +02:00
zh_CN Encourage to install python packages without administrative rights 2018-09-11 08:54:37 +02: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 docs: Make the Python scripts Python 2&3 compatible 2018-09-10 08:37:43 +02:00
docs_common.mk Docs: Check Python packages 2018-08-30 13:20:42 +02:00
Doxyfile docs/sleep: mention new wakeup sources, use generated API reference 2018-09-06 15:42:34 +08:00
gen-dxd.py docs: Make the Python scripts Python 2&3 compatible 2018-09-10 08:37:43 +02:00
gen-version-specific-includes.py docs: Make the Python scripts Python 2&3 compatible 2018-09-10 08:37:43 +02: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
link-roles.py docs: Make the Python scripts Python 2&3 compatible 2018-09-10 08:37:43 +02:00
local_util.py docs: Make the Python scripts Python 2&3 compatible 2018-09-10 08:37:43 +02:00
README.md Replace all DOS line endings with Unix 2018-07-12 19:10:37 +08:00
requirements.txt Encourage to install python packages without administrative rights 2018-09-11 08:54:37 +02: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
TEMPLATE_EXAMPLE_README.md docs: Add "Creating Examples" docs page, template example README 2018-06-14 16:49:22 +10: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.