Name		Name	Last commit message	Last commit date
parent directory ..
_static		_static
en		en
zh_CN		zh_CN
ADF_TEMPLATE_EXAMPLE_README_CN.md		ADF_TEMPLATE_EXAMPLE_README_CN.md
ADF_TEMPLATE_EXAMPLE_README_EN.md		ADF_TEMPLATE_EXAMPLE_README_EN.md
Doxyfile		Doxyfile
README.md		README.md
check_doc_warnings.sh		check_doc_warnings.sh
check_lang_folder_sync.sh		check_lang_folder_sync.sh
conf_common.py		conf_common.py
docs_common.mk		docs_common.mk
gen-dxd.py		gen-dxd.py
gen-kconfig-doc.py		gen-kconfig-doc.py
html_redirects.py		html_redirects.py
kconfiglib.py		kconfiglib.py
link-roles.py		link-roles.py
local_util.py		local_util.py
page_redirects.txt		page_redirects.txt
requirements.txt		requirements.txt
setuptools.requirements.txt		setuptools.requirements.txt
sphinx-known-warnings.txt		sphinx-known-warnings.txt

README.md

Documentation Source Folder

This folder contains source files of ESP-ADF 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:

The above URLs are all for the master branch latest version. Click on the link in the bottom right corner to download the PDF version.

The documentation is built using the python package esp-docs, which can be installed by running:

pip install esp-docs

For a summary of available options, run:

build-docs --help

For more information, see ESP-Docs User Guide.

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.