blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-10 01:29:21 -04:00
Code Issues Projects Releases Wiki Activity
esp-idf/docs
History
Marius Vikhammer 3fd37d0b59 adc: change the way data is formattted in adc_dma_demo 
The way the adc_dma_demo data was formatted caused it go get parsed as markdown syntax.

Changed it be more "human" readable as well as put all ADC examples in a common folder
2021-01-25 04:51:40 +00:00
..
_static
provide user guide for ESP32-DevKitM-1
2021-01-05 12:32:08 +08:00
doxygen
component/bt: add BLE v5.0 feature for bluedroid host
2021-01-15 17:55:12 +08:00
en
adc: change the way data is formattted in adc_dma_demo
2021-01-25 04:51:40 +00:00
extensions
doc: custom list filter directive
2020-02-20 18:08:05 +08:00
idf_extensions
Docs: Add C3 support to build_docs
2020-12-28 12:25:03 +08:00
latex_templates
Whitespace: Automated whitespace fixes (large commit)
2020-11-11 07:36:35 +00:00
test
docs: Adds CI tests for the doc building process.
2020-07-28 17:48:19 +08:00
zh_CN
Merge branch 'feature/c3_master_flash_enc_support' into 'master'
2021-01-22 12:58:38 +08:00
build_docs.py
docs: add warning for doxygen version
2020-09-03 13:48:40 +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 C3 support to build_docs
2020-12-28 12:25:03 +08:00
doxygen-known-warnings.txt
docs: Resolve doxygen & Sphinx warnings
2020-02-07 16:37:45 +11:00
generate_chart.py
add chart of version support to version.rst
2020-09-09 11:32:44 +02: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: bump cairosvg from 2.4.2 to 2.5.1 in /docs
2021-01-13 19:41:16 +11:00
sanitize_version.py
docs: deploy docs to production server from CI
2020-03-16 14:36:23 +11:00
sphinx-known-warnings.txt
ulp: added support to building code for riscv ULP coprocessor
2020-07-15 15:28:49 -03: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.