Halaman utama Jelajahi Bantuan
Masuk
RT-Thread-packages
/
esp-idf
cermin dari https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Berkas Masalah 0 Wiki
Pohon: c2bb0762bb
Ranting Tag
esp-idf
/
docs
David Čermák e2f72f449c Merge branch 'feature/ethernet_flow_control' into 'master' 5 tahun lalu
..
_static 5773767b81 Provide getting started guide for ESP32-Ethernet-Kit-V1.2 based on V1.1 5 tahun lalu
en e2f72f449c Merge branch 'feature/ethernet_flow_control' into 'master' 5 tahun lalu
extensions 63b76a9d90 doc: custom list filter directive 6 tahun lalu
idf_extensions b529b757aa doc: fall back to CI_COMMIT_REF_NAME as a branch name 5 tahun lalu
latex_templates 407275f681 doc: add latex and PDF generation to build_docs 5 tahun lalu
test ba546a0d91 docs: Adds CI tests for the doc building process. 5 tahun lalu
zh_CN 685c3fc70c Merge branch 'test/merge_ble_mesh_node_and_provioner_in_console' into 'master' 5 tahun lalu
Doxyfile b30522f701 esp32, esp32s2: move sleep modes code to esp_system 5 tahun lalu
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 tahun lalu
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 tahun lalu
build_docs.py dd192a2113 docs: adds to build_docs.py an encoding check suitable for windows 5 tahun lalu
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 tahun lalu
conf_common.py b30bd7a2ef esp32s2: add CP_DMA driver 5 tahun lalu
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 tahun lalu
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 tahun lalu
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 tahun lalu
requirements.txt ccdd3d3db8 docs: update sphinx_idf_theme documentation 5 tahun lalu
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI 5 tahun lalu
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor 5 tahun lalu

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.