mirror of https://github.com/espressif/esp-idf.git synced 2026-02-03 21:46:31 +00:00

Files

Shu Chen 6061a547e5 esp_phy: decouple esp_phy component from esp_wifi and bt

* add esp-phy-lib submodule
* move libphy.a and phy_init.c from esp_wifi to esp_phy
* move librtc.a from esp_wifi to esp_phy
* move libbtbb.a from bt to esp_phy
* corresponding updates to build system

2021-06-03 16:17:31 +08:00

_static

Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master'

2021-05-31 10:07:19 +00:00

doxygen

docs: Add random number generation to the API Reference System section

2021-05-18 16:05:42 +10:00

esp_phy: decouple esp_phy component from esp_wifi and bt

2021-06-03 16:17:31 +08:00

extensions

doc: Add support for redirects to external URL

2021-04-27 17:01:24 +08:00

idf_extensions

Add warning to docs output if fastbuild

2021-05-06 09:17:41 +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

docs: document contained an invalid character which couldnt be rendered in the PDF

2021-06-01 09:34:52 +08:00

build_docs.py

docs: add fast build feature and activate it in CI

2021-04-28 16:32:35 +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: add rf calibration docs for S2 and C3

2021-05-26 10:09:50 +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

Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master'

2021-05-31 11:12:51 +00: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: add warning for outdated versions

2021-04-27 09:02:11 +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.