mirror of https://github.com/espressif/esp-idf.git synced 2025-12-26 21:29:33 +00:00

Files

Krzysztof Budzynski d25d3789e9 Merge branch 'doc/update_dead_url_links_to_iot_solution_repo' into 'master'

fix dead links directed to ESP-IoT-Solution repo

Closes DOC-1101 and IDFCI-472

See merge request espressif/esp-idf!12535

2021-03-26 14:23:06 +00:00

_static

Add ESP32-C3-DevKitC-02 User Guide

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

doxygen

docs: update api-reference chapters for C3

2021-03-01 14:58:08 +08:00

Merge branch 'doc/update_dead_url_links_to_iot_solution_repo' into 'master'

2021-03-26 14:23:06 +00:00

extensions

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

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

idf_extensions

docs: initial update of programming guide for C3

2021-02-01 15:40:02 +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 'doc/update_dead_url_links_to_iot_solution_repo' into 'master'

2021-03-26 14:23:06 +00: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

docs: updated system api-reference chapters for C3

2021-03-15 18:51:12 +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

Docs: build doc with new layout for target and version select

2021-03-12 16:15:56 +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: initial update of programming guide for C3

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