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

Files

Darian Leung 2be772af1c Sphinx uses reredirect extension

This commit removes the custom HTML rediiect extension and uses
the sphinx-reredirect extension instead. The sphinx-reredirect
extension allows for redirection to external links as well as
support for wildcards.

2021-04-23 00:02:30 +08:00

_static

Add ESP32-C3-DevKitC-02 User Guide

2021-03-17 06:40:33 +00:00

doxygen

vfs: add doc links

2021-04-15 15:19:00 +08:00

Sphinx uses reredirect extension

2021-04-23 00:02:30 +08:00

extensions

Sphinx uses reredirect extension

2021-04-23 00:02:30 +08:00

idf_extensions

docs: add C3 TRM links

2021-04-09 11:01:29 +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

Sphinx uses reredirect extension

2021-04-23 00:02:30 +08:00

build_docs.py

docs: initial update of programming guide for C3

2021-02-01 15:40:02 +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

Sphinx uses reredirect extension

2021-04-23 00:02:30 +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

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

Sphinx uses reredirect extension

2021-04-23 00:02:30 +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: Adds secure_boot_v2 for ESP32-C3 ECO3

2021-04-08 14:22:46 +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.