Startsida Utforska Hjälp
Logga in
RT-Thread-packages
/
esp-idf
spegling av https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Filer Ärenden 0 Wiki
Träd: ebe62ee6d0
Grenar Taggar
esp-idf
/
docs
Wang Fang 256571a4f4 fix the formatting issues described in DOC-257 5 år sedan
..
_static 95ed99671b Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master' 5 år sedan
en 32761b9782 docs: fix link_roles not linking correctly for certain files 5 år sedan
extensions 63b76a9d90 doc: custom list filter directive 6 år sedan
idf_extensions 32761b9782 docs: fix link_roles not linking correctly for certain files 5 år sedan
latex_templates 407275f681 doc: add latex and PDF generation to build_docs 5 år sedan
zh_CN 256571a4f4 fix the formatting issues described in DOC-257 5 år sedan
Doxyfile a34409cffc esp_rom: extract common CRC apis into esp_rom_crc.h 5 år sedan
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 år sedan
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 år sedan
build_docs.py 67ea59d605 docs: fix check_docs not working for multiple builders 5 år sedan
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 år sedan
conf_common.py 7d989e08fd doc: Fix passing of build macros to Doxygen 5 år sedan
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 år sedan
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 år sedan
page_redirects.txt c65c1716cd Add redirect link from user-guide-kaluga-1-v1.2 to user-guide-esp32-s2-kaluga-1-kit 5 år sedan
requirements.txt 8a3d806798 doc: update CI to build PDF 5 år sedan
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI 5 år sedan
sphinx-known-warnings.txt 67ea59d605 docs: fix check_docs not working for multiple builders 5 år sedan

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.