Files

STB3 0bde61e3ca Update eclipse-setup.rst

Chapter Flash from Eclipse: Changed "Select Make Targets -> ..." to "Select Build Targets -> ..."    to match the Eclipse wording. Same with "Project -> Make Target" replace Make by build to match the Eclipse wording.

2018-02-15 21:13:01 +01:00

_static

Docs for ESP32 DevKitC V4

2018-01-31 18:31:13 +01:00

api-guides

Remove the THEN keyword from IF. Closes https://github.com/espressif/esp-idf/issue/1606

2018-02-13 15:06:05 +01:00

api-reference

component/bt: Update BLE examples tutorials and ReadMe files

2018-01-25 16:59:40 +08:00

contribute

Merge branch 'feature/support-markdown-docs' into 'master'

2018-01-23 15:36:12 +08:00

get-started

Update eclipse-setup.rst

2018-02-15 21:13:01 +01:00

hw-reference

Docs for ESP32 DevKitC V4

2018-01-31 18:31:13 +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

docs : Add support for markdown files

2018-01-15 13:58:31 +08:00

Mass replacement of http with https urls, fixed broken urls

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

Doxyfile

component/bt: Add SPP profile

2018-01-05 16:48:29 +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

docs: Add a temporary index page to get CN docs started

2018-01-11 18:18:55 +08:00

kconfiglib.py

Fail CI build on Sphinx warnings

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

link-roles.py

Custom link roles have been extended to provide an option of displaying some text where originally a bare link is rendered

2018-01-17 20:01:36 +01: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

docs : Add support for markdown files

2018-01-15 13:58:31 +08: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/