mirror of https://github.com/espressif/esp-idf.git synced 2026-02-08 22:39:43 -05:00

Files

Ivan Grokhotkov 7e3ac34704 Merge branch 'bugfix/fix_i2s_doc' into 'master'

docs: fix i2s code snippet for interrupt flags setting

See merge request !1637

2017-12-07 13:50:49 +08:00

_static

Pin descriptions, overview diagram and board dimensions carried over from ESP32-PICO-KIT_Datasheet_EN.pdf. The datasheet looks redundant and will not be used.

2017-12-05 22:03:38 +01:00

api-guides

docs: link to FreeRTOS APIs from SMP changes documentation

2017-12-07 12:41:24 +08:00

api-reference

Merge branch 'bugfix/fix_i2s_doc' into 'master'

2017-12-07 13:50:49 +08:00

contribute

Implement ‘blockdiag - simple block-diagram image generator’ to illustrate documentation with block diagrams, sequence diagrams, activity diagrams and logical network diagrams

2017-11-07 18:17:53 +01:00

get-started

Pin descriptions, overview diagram and board dimensions carried over from ESP32-PICO-KIT_Datasheet_EN.pdf. The datasheet looks redundant and will not be used.

2017-12-05 22:03:38 +01:00

hw-reference

Small updates of documentation

2017-10-31 07:36:55 +01:00

security

doc: Add internal links for chapters and fix typos

2017-11-09 11:45:13 +08:00

about.rst

Getting started guides

2017-04-27 19:51:42 +02:00

check_doc_warnings.sh

ci: Add new check_doc_warnings.sh script, pre-process log lines

2017-09-14 13:46:35 +10:00

conf.py

Implement ‘blockdiag - simple block-diagram image generator’ to illustrate documentation with block diagrams, sequence diagrams, activity diagrams and logical network diagrams

2017-11-07 18:17:53 +01:00

Mass replacement of http with https urls, fixed broken urls

2017-09-06 08:16:01 +02:00

Doxyfile

docs: add FreeRTOS API docs

2017-12-07 12:01:14 +08:00

gen-dxd.py

docs: Generate Doxygen directives for API documentation

2017-05-19 18:26:02 +02:00

gen-kconfig-doc.py

docs: generate documentation for Kconfig options

2017-08-22 15:12:34 +08:00

index.rst

Getting started guides

2017-04-27 19:51:42 +02:00

kconfiglib.py

Fail CI build on Sphinx warnings

2017-09-12 07:12:57 +02:00

link-roles.py

docs: use custom roles to generate GitHub links

2017-01-20 17:22:47 +08:00

Makefile

docs: Generate Doxygen directives for API documentation

2017-05-19 18:26:02 +02:00

README.md

Mass replacement of http with https urls, fixed broken urls

2017-09-06 08:16:01 +02:00

repo_util.py

docs: use custom roles to generate GitHub links

2017-01-20 17:22:47 +08:00

requirements.txt

Implement ‘blockdiag - simple block-diagram image generator’ to illustrate documentation with block diagrams, sequence diagrams, activity diagrams and logical network diagrams

2017-11-07 18:17:53 +01:00

resources.rst

Mass replacement of http with https urls, fixed broken urls

2017-09-06 08:16:01 +02:00

sphinx-known-warnings.txt

Upgraded Sphinx to latest release 1.6.5 that contains a fix to https://github.com/sphinx-doc/sphinx/issues/4041 . Upgraded Breathe to latest release 4.7.3 as well.

2017-10-31 22:57:39 +01:00

README.md

Documentation Source Folder

This folder contains source files of ESP-IDF documentation.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated instantly on each commit:

Main server: https://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/
Mirror: https://dl.espressif.com/doc/esp-idf/latest/