alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
esp-idf/docs
History
Valerii Koval bc397f8b7d Add new section about using ESP-IDF with PlatformIO 
This adds a description of PlatformIO ecosystem, tutorials, examples

Merges https://github.com/espressif/esp-idf/pull/5132
2020-05-06 12:55:22 +02:00
..
_static
Add new section about using ESP-IDF with PlatformIO
2020-05-06 12:55:22 +02:00
en
Add new section about using ESP-IDF with PlatformIO
2020-05-06 12:55:22 +02:00
extensions
doc: custom list filter directive
2020-02-20 18:08:05 +08:00
idf_extensions
doc: remove links to translation if building PDF
2020-04-23 18:59:37 +08:00
latex_templates
doc: add latex and PDF generation to build_docs
2020-04-15 17:14:22 +08:00
zh_CN
Add new section about using ESP-IDF with PlatformIO
2020-05-06 12:55:22 +02:00
build_docs.py
doc: add latex and PDF generation to build_docs
2020-04-15 17:14:22 +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
Add build system support for programming ESP32-S2 using DFU utils
2020-04-30 07:59:18 +02:00
Doxyfile
Doc: S2 HMAC documentation
2020-04-27 12:25:46 +08:00
doxygen-known-warnings.txt
docs: Resolve doxygen & Sphinx warnings
2020-02-07 16:37:45 +11:00
page_redirects.txt
doc: Create redirects for ESP32 hw-reference get-started URLs
2020-03-24 14:56:12 +11: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
doc: update CI to build PDF
2020-04-15 17:14:27 +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
docs: Resolve doxygen & Sphinx warnings
2020-02-07 16:37:45 +11: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.