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
6c17e3a64c
esp-idf/docs
History
Krzysztof Budzynski 6c17e3a64c Merge branch 'docs/Specify_two_calls_to_RingbufferReceive_is_required_in_wrap_mode' into 'master' 
Add a note to specify that two calls to RingbufferReceive are required in wrap mode

Closes IDF-1980

See merge request espressif/esp-idf!9999
2020-08-19 20:00:27 +08:00
..
_static Provide getting started guide for ESP32-Ethernet-Kit-V1.2 based on V1.1 2020-07-28 13:49:33 +08:00
en Merge branch 'docs/Specify_two_calls_to_RingbufferReceive_is_required_in_wrap_mode' into 'master' 2020-08-19 20:00:27 +08:00
extensions doc: custom list filter directive 2020-02-20 18:08:05 +08:00
idf_extensions doc: fall back to CI_COMMIT_REF_NAME as a branch name 2020-07-29 18:22:51 +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 'doc/hw-ref/esp32-s2/kaluga-kit-v1.3' into 'master' 2020-08-14 18:39:18 +08:00
build_docs.py docs: adds to build_docs.py an encoding check suitable for windows 2020-08-11 13:52:21 +02: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 esp32s2: add CP_DMA driver 2020-08-04 15:28:32 +08:00
Doxyfile esp32, esp32s2: move sleep modes code to esp_system 2020-08-17 19:09:23 +08:00
doxygen-known-warnings.txt docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11: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 docs: update sphinx_idf_theme documentation 2020-07-06 10:45:43 +08: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.