Skip to content

Files

Latest commit

projectgusprojectgus
Merge branch 'bugfix/esp_event_bugfixes_v4.0' into 'release/v4.0'
Apr 9, 2020
fd58809 · Apr 9, 2020

History

History
This branch is 960 commits ahead of, 30268 commits behind espressif/esp-idf:master.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
_static
_static
Dec 24, 2019
en
en
Apr 9, 2020
zh_CN
zh_CN
Mar 22, 2020
Doxyfile
Doxyfile
Jul 5, 2019
README.md
README.md
Oct 26, 2018
TEMPLATE_EXAMPLE_README.md
TEMPLATE_EXAMPLE_README.md
Jul 8, 2019
check_doc_warnings.sh
check_doc_warnings.sh
Feb 27, 2019
check_lang_folder_sync.sh
check_lang_folder_sync.sh
Mar 16, 2018
conf_common.py
conf_common.py
Aug 19, 2019
docs_common.mk
docs_common.mk
Oct 29, 2019
gen-dxd.py
gen-dxd.py
Dec 5, 2018
gen-toolchain-links.py
gen-toolchain-links.py
Nov 4, 2019
gen-version-specific-includes.py
gen-version-specific-includes.py
Feb 19, 2019
html_redirects.py
html_redirects.py
Dec 18, 2018
issue_template.md
issue_template.md
Oct 26, 2018
link-roles.py
link-roles.py
Dec 5, 2018
local_util.py
local_util.py
May 21, 2019
page_redirects.txt
page_redirects.txt
Jul 9, 2019
requirements.txt
requirements.txt
Feb 14, 2020
sphinx-known-warnings.txt
sphinx-known-warnings.txt
Jul 9, 2019

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.