daiziyan 5da482e871 docs: update CN translation and keep line number consistent for all documents in get-started section преди 4 години
..
_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 5da482e871 docs: update CN translation and keep line number consistent for all documents in get-started section преди 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 5da482e871 docs: update CN translation and keep line number consistent for all documents in get-started section преди 4 години
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer преди 5 години
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 bf89a900a3 docs: fix docs not being able to be built locally due to missing env variable. преди 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.