alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
9207c6ca8e
esp-idf/docs
History
Krzysztof Budzynski a1aed140a9 Merge branch 'doc/bluetooth_format_fix' into 'master' 
docs: fix broken bullet list in BT chapter

See merge request espressif/esp-idf!11044
2020-11-09 12:16:53 +08:00
..
_static Add ESP32-S2-DevKitM-1 User Guide 2020-11-06 00:50:33 +00:00
en Merge branch 'doc/bluetooth_format_fix' into 'master' 2020-11-09 12:16:53 +08:00
extensions doc: custom list filter directive 2020-02-20 18:08:05 +08:00
idf_extensions soc: descriptive part occupy whole component 2020-10-28 07:21:29 +08:00
latex_templates doc: add latex and PDF generation to build_docs 2020-04-15 17:14:22 +08:00
test docs: Adds CI tests for the doc building process. 2020-07-28 17:48:19 +08:00
zh_CN Merge branch 'feature/bringup_esp32s3_fpga_update_rmt_driver' into 'master' 2020-11-07 07:15:53 +08:00
build_docs.py docs: add warning for doxygen version 2020-09-03 13:48:40 +08:00
check_lang_folder_sync.sh global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 2020-04-03 01:10:02 +02:00
conf_common.py doc: dedicated gpio api reference 2020-10-20 21:06:10 +08:00
Doxyfile docs: change some header path to use IDF_TARGET 2020-10-29 12:20:16 +08:00
doxygen-known-warnings.txt docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
generate_chart.py add chart of version support to version.rst 2020-09-09 11:32:44 +02:00
get_github_rev.py docs: add 'edit-on-github' link to html theme 2020-05-06 17:25:23 +08:00
page_redirects.txt docs: repurpose WROVER-KIT debugging guide for Kaluga-1 2020-07-24 15:54:47 +02:00
README.md docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 2020-03-16 14:36:23 +11:00
requirements.txt add chart of version support to version.rst 2020-09-09 11:32:44 +02:00
sanitize_version.py docs: deploy docs to production server from CI 2020-03-16 14:36:23 +11:00
sphinx-known-warnings.txt ulp: added support to building code for riscv ULP coprocessor 2020-07-15 15:28:49 -03:00
TEMPLATE_EXAMPLE_README.md examples: Update system examples README 2019-08-28 16:19:40 +08:00

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.