Alexey Gerenkov c2c33ac9a5 docs: Fixes OpenOCD debug level option		před 4 roky
..
_static	38b0870fab docs: self host docs	před 4 roky
en	c2c33ac9a5 docs: Fixes OpenOCD debug level option	před 4 roky
latex_templates	38b0870fab docs: self host docs	před 4 roky
zh_CN	c2c33ac9a5 docs: Fixes OpenOCD debug level option	před 4 roky
Doxyfile	38b0870fab docs: self host docs	před 4 roky
README.md	14f4c196c0 windows: Update other MSYS2 package names to all be Python 3	před 5 roky
TEMPLATE_EXAMPLE_README.md	df4e227855 docs: Add "Creating Examples" docs page, template example README	před 7 roky
check_doc_warnings.sh	e1e8c36492 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.	před 6 roky
check_lang_folder_sync.sh	621076f329 Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files	před 7 roky
conf_common.py	38b0870fab docs: self host docs	před 4 roky
docs_common.mk	9911823658 docs: Add ESP-IDF support period policy	před 6 roky
gen-dxd.py	b56ed1a99e docs: Correct Python coding style	před 7 roky
gen-toolchain-links.py	78003e9437 docs: Fix toolchain URL generation for macos	před 5 roky
gen-version-specific-includes.py	38b0870fab docs: self host docs	před 4 roky
get_github_rev.py	38b0870fab docs: self host docs	před 4 roky
html_redirects.py	b240a181b7 docs: Add option to redirect documentation pages which have moved	před 7 roky
issue_template.md	6c2bffe53c build system: Also get IDF version from annotated tags only	před 5 roky
latex_builder.py	38b0870fab docs: self host docs	před 4 roky
link-roles.py	38b0870fab docs: self host docs	před 4 roky
local_util.py	b56ed1a99e docs: Correct Python coding style	před 7 roky
requirements.txt	38b0870fab docs: self host docs	před 4 roky
sanitize_version.py	38b0870fab docs: self host docs	před 4 roky
sphinx-known-warnings.txt	e1e8c36492 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.	před 6 roky

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.

README.md

Documentation Source Folder

Hosted Documentation

Building Documentation

For MSYS2 MINGW32 on Windows