Dai Zi Yan fdf4070cdc doc:updated cn translation for language.rst and version.rst to provide new layout for version/target select 5 жил өмнө
..
_static 539f7edbb3 Docs: build doc with new layout for target and version select 4 жил өмнө
doxygen 00b9df2937 Add support of NimBLE host to Blufi 4 жил өмнө
en fdf4070cdc doc:updated cn translation for language.rst and version.rst to provide new layout for version/target select 4 жил өмнө
extensions eeab4e4469 docs: add google analytics tracking 4 жил өмнө
idf_extensions 626964beae docs: add C3 TRM links 4 жил өмнө
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 жил өмнө
test 548fd02d10 docs: initial update of programming guide for C3 5 жил өмнө
zh_CN fdf4070cdc doc:updated cn translation for language.rst and version.rst to provide new layout for version/target select 4 жил өмнө
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 6 жил өмнө
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 жил өмнө
build_docs.py 548fd02d10 docs: initial update of programming guide for C3 5 жил өмнө
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 жил өмнө
conf_common.py eeab4e4469 docs: add google analytics tracking 4 жил өмнө
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 жил өмнө
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 жил өмнө
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 жил өмнө
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 жил өмнө
requirements.txt d13b69558a docs: add warning for outdated versions 4 жил өмнө
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 жил өмнө
sphinx-known-warnings.txt 00b9df2937 Add support of NimBLE host to Blufi 4 жил өмнө

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

The documentation build requirements Python 3 and running the wrapper ./build_docs.py tool. Running ./build_docs.py --help will give a summary of available options.

See Documenting Code in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the ./build_docs.py tool.