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
esp-idf/docs
History
wangmengyang 50af558df9 update pm document with changes in bluetooth that supports automatic light sleep in case that external 32.768KHz crystal is used as the sleep clock 
If bluetooth modem sleep is enabled and "External 32kHz crystal" is used as bluetooth sleep clock, the power management lock "ESP_PM_NO_LIGHT_SLEEP" in bluetooth is released for the periods of time when Bluetooth enters modem sleep. In this case automatic light sleep is allowed.
2019-07-04 07:14:02 +00:00
..
_static
Port NimBLE Host Stack on ESP-IDF
2019-06-25 09:03:58 +08:00
en
update pm document with changes in bluetooth that supports automatic light sleep in case that external 32.768KHz crystal is used as the sleep clock
2019-07-04 07:14:02 +00:00
zh_CN
zh_CN translation of fatal_error
2019-07-04 14:01:53 +08: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.
2019-02-27 22:11:59 +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 make-related documents:
2019-07-04 13:16:18 +08:00
docs_common.mk
Fix Python 3 compatibility issues
2018-10-24 11:20:54 +02:00
Doxyfile
ESP Local Control Feature Added
2019-07-03 21:31:04 +05:30
gen-dxd.py
docs: Correct Python coding style
2018-12-05 08:22:33 +01:00
gen-toolchain-links.py
docs: fix generation of toolchain links
2019-06-11 19:46:56 +08:00
gen-version-specific-includes.py
doc: Fix invalid 'This command will clone master' note in docs
2019-02-19 04:05:39 +00:00
html_redirects.py
docs: Add option to redirect documentation pages which have moved
2018-12-18 14:07:43 +11:00
issue_template.md
doc: include compiler version in issue template
2018-10-26 12:47:32 +08:00
link-roles.py
docs: Correct Python coding style
2018-12-05 08:22:33 +01:00
local_util.py
Download font file only is not exists in target location
2019-05-21 09:51:39 +08:00
README.md
doc: Fix doc builds on Windows MINGW32, add some doc build documentation
2018-10-26 04:04:56 +00:00
requirements.txt
Fixed Breathe version to avoid docs build failure on ReadTheDocs server. Provided RTD project configuration file to be able to select python version for specific to esp-idf release.
2019-05-15 20:40:48 +08:00
sphinx-known-warnings.txt
esp_flash: update the document to the latest API
2019-06-20 11:50:23 +08: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.

Building Documentation

  • Install make and doxygen for your platform (make may already be installed as an ESP-IDF prerequisite).
  • Change to either the docs/en or docs/zh_CN subdirectory and run make html
  • make will probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-run make html to build the docs.

For MSYS2 MINGW32 on Windows

If using Windows and the MSYS2 MINGW32 terminal, run this command before running "make html" the first time:

pacman -S doxygen mingw-w64-i686-python2-pillow

Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.