mirror of https://github.com/espressif/esp-idf.git synced 2026-02-08 08:44:50 +00:00

Files

Angus Gratton ffaa71bcd6 docs: Add version-specific include files, version documentation

* "git clone" command and a small version header are generated
  depending on git properties.
* Add Versions page with details about each version
* Make it clear using master branch is living on the "bleeding
  edge"

2018-08-06 15:38:32 +10:00

_static

Added description of ESP32-PICO-KIT V4.1 board

2018-07-18 20:02:43 +02:00

docs: Add version-specific include files, version documentation

2018-08-06 15:38:32 +10:00

zh_CN

docs: Add version-specific include files, version documentation

2018-08-06 15:38:32 +10:00

check_doc_warnings.sh

Adjusted CI configuration to handle 'en' and 'zh_CN' language versions

2018-03-13 22:07:31 +01:00

check_lang_folder_sync.sh

Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files

2018-03-16 07:54:58 +01:00

conf_common.py

docs: conf.py: check return code when calling os.system

2018-06-21 15:22:56 +08:00

Doxyfile

Merge branch 'feature/http_server_finalize' into 'master'

2018-07-23 13:11:04 +08:00

gen-dxd.py

Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions

2018-03-13 22:07:31 +01:00

gen-kconfig-doc.py

Kconfig: split out compiler options, add them to reference

2018-06-15 15:49:23 +08:00

gen-version-specific-includes.py

docs: Add version-specific include files, version documentation

2018-08-06 15:38:32 +10:00

issue_template.md

docs: Switch base URL from esp-idf.readthedocs.io to docs.espressif.com

2018-06-19 11:23:33 +00:00

kconfiglib.py

Fail CI build on Sphinx warnings

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

link-roles.py

Implemented docutils custom role that renders a link to current documentation page on Read The Docs in another language version

2018-05-21 10:30:07 +08:00

local_util.py

docs: speed up incremental builds

2018-03-07 17:45:15 +08:00

README.md

Replace all DOS line endings with Unix

2018-07-12 19:10:37 +08:00

requirements.txt

docs : Add support for markdown files

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

TEMPLATE_EXAMPLE_README.md

docs: Add "Creating Examples" docs page, template example README

2018-06-14 16:49:22 +10: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.