Files

laokaiyao f7f8c9c11f driver/i2s: support i2s on c3 and s3

1. Support i2s on esp32c3 and esp32s3
    2. Refactor i2s_config_t to avoid breaking change
    2. Fix a bug that receiving unavailable values from message queue when dma queue has been re-allocted
    4. Support i2s unit test on esp32c3 and esp32s3

2021-08-04 10:20:03 +08:00

_static

docs/add_esp32-s2-devkitc-1_user_guide

2021-07-30 14:00:45 +08:00

doxygen

esp32: move spiram, himem

2021-07-16 20:14:26 +08:00

driver/i2s: support i2s on c3 and s3

2021-08-04 10:20:03 +08:00

extensions

doc: Add support for redirects to external URL

2021-04-27 17:01:24 +08:00

idf_extensions

docs: add S3 TRM URL

2021-07-12 16:39:23 +08:00

latex_templates

Whitespace: Automated whitespace fixes (large commit)

2020-11-11 07:36:35 +00:00

test

docs: initial update of programming guide for C3

2021-02-01 15:40:02 +08:00

zh_CN

Merge branch 'feature/support_noinit_section_in_psram_on_esp32' into 'master'

2021-07-31 09:58:59 +00:00

build_docs.py

build docs: enable building of S3 docs

2021-06-09 09:30:36 +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: update tinyusb document to support esp32s3

2021-07-22 10:43:10 +08:00

doxygen-known-warnings.txt

docs: Resolve doxygen & Sphinx warnings

2020-02-07 16:37:45 +11:00

generate_chart.py

style: format python files with isort and double-quote-string-fixer

2021-01-26 10:49:01 +08: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

doc: update tinyusb document to support esp32s3

2021-07-22 10:43:10 +08: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: add warning for outdated versions

2021-04-27 09:02:11 +08:00

sanitize_version.py

style: format python files with isort and double-quote-string-fixer

2021-01-26 10:49:01 +08:00

sphinx-known-warnings.txt

docs: ignore duplicate def warning in BT docs

2021-06-30 15:10:43 +08: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.