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
Michael (XIAO Xufeng) 2b323e7180 Merge branch 'bugfix/fix_dac_driver_ut' into 'master' 
Driver(dac): fix DAC-DMA driver and unit test

Closes IDF-1407

See merge request espressif/esp-idf!8814
2020-08-31 00:05:34 +08:00
..
_static
Provide getting started guide for ESP32-Ethernet-Kit-V1.2 based on V1.1
2020-07-28 13:49:33 +08:00
en
Merge branch 'bugfix/fix_dac_driver_ut' into 'master'
2020-08-31 00:05:34 +08:00
extensions
doc: custom list filter directive
2020-02-20 18:08:05 +08:00
idf_extensions
docs: fix version specific note on local build
2020-08-21 09:24:41 +00:00
latex_templates
doc: add latex and PDF generation to build_docs
2020-04-15 17:14:22 +08:00
test
docs: Adds CI tests for the doc building process.
2020-07-28 17:48:19 +08:00
zh_CN
Merge branch 'bugfix/get_started_inconsistency' into 'master'
2020-08-28 20:23:17 +08:00
build_docs.py
docs: adds to build_docs.py an encoding check suitable for windows
2020-08-11 13:52:21 +02: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 copybutton package to conf_common.py
2020-08-27 02:48:43 +00:00
Doxyfile
dfiver(dac): add dac dma driver and unit test
2020-08-26 06:23:24 +00:00
doxygen-known-warnings.txt
docs: Resolve doxygen & Sphinx warnings
2020-02-07 16:37:45 +11: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: update sphinx_idf_theme documentation
2020-07-06 10:45:43 +08: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.