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
048fd80450
esp-idf/docs
History
Angus Gratton 332e243f17 Merge branch 'feature/msys2_env_update_v3.3' into 'release/v3.3' 
windows: Update pre-compiled MSYS2 environment

See merge request espressif/esp-idf!9035
2020-06-12 07:26:41 +08:00
..
_static ble_mesh: Doc miscellaneous fixes 2020-05-21 17:49:58 +08:00
en Merge branch 'feature/msys2_env_update_v3.3' into 'release/v3.3' 2020-06-12 07:26:41 +08:00
zh_CN windows: Update pre-compiled MSYS2 environment 2020-06-02 18:32:42 +10: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 docs: remove invalid arg in confgen invocation on docs generation 2019-01-16 08:16:09 +08:00
docs_common.mk docs: Add ESP-IDF support period policy 2019-10-29 16:36:08 +11:00
Doxyfile esp_common: add version definitions in code and build system 2020-04-03 01:24:33 +02:00
gen-dxd.py docs: Correct Python coding style 2018-12-05 08:22:33 +01:00
gen-toolchain-links.py docs: Correct Python coding style 2018-12-05 08:22:33 +01: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 docs: Correct Python coding style 2018-12-05 08:22:33 +01:00
README.md windows: Update other MSYS2 package names to all be Python 3 2020-06-04 18:39:20 +10:00
requirements.txt Docs: Fix sphinxcontrib dependencies 2020-02-14 10:40:07 +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. 2019-02-27 22:11:59 +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.

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-python-pillow

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