Marius Vikhammer 207cbabc51 doc: update chip features in getting started 5 anos atrás
..
_static 95ed99671b Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master' 5 anos atrás
en 207cbabc51 doc: update chip features in getting started 5 anos atrás
extensions 63b76a9d90 doc: custom list filter directive 6 anos atrás
idf_extensions e3664e297b docs: Redirect all of Doxygen stderr to the warnings log 5 anos atrás
latex_templates 407275f681 doc: add latex and PDF generation to build_docs 5 anos atrás
zh_CN dc06fd3c20 docs: change redirection link in get-started 5 anos atrás
Doxyfile e3664e297b docs: Redirect all of Doxygen stderr to the warnings log 5 anos atrás
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 6 anos atrás
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 anos atrás
build_docs.py 302a43562d docs: fix check_docs not working for multiple builders 5 anos atrás
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 anos atrás
conf_common.py 2b270bccbf doc: Fix passing of build macros to Doxygen 5 anos atrás
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 anos atrás
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 anos atrás
page_redirects.txt c65c1716cd Add redirect link from user-guide-kaluga-1-v1.2 to user-guide-esp32-s2-kaluga-1-kit 5 anos atrás
requirements.txt 61904135b3 docs: update sphinx_idf_theme documentation 5 anos atrás
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI 6 anos atrás
sphinx-known-warnings.txt 302a43562d docs: fix check_docs not working for multiple builders 5 anos atrás

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.