c3d99dd2e4
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. |
||
---|---|---|
.. | ||
_static | ||
en | ||
zh_CN | ||
check_doc_warnings.sh | ||
check_lang_folder_sync.sh | ||
conf_common.py | ||
docs_common.mk | ||
Doxyfile | ||
gen-dxd.py | ||
gen-version-specific-includes.py | ||
issue_template.md | ||
link-roles.py | ||
local_util.py | ||
README.md | ||
requirements.txt | ||
sphinx-known-warnings.txt | ||
TEMPLATE_EXAMPLE_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
- English: https://docs.espressif.com/projects/esp-idf/en/latest/
- 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
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.