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
Angus Gratton 059353b0c2 Merge branch 'feature/refactor_common_secure_boot_code' into 'master' 
secure_boot/flash_encryption: Refactoring

Closes IDF-2582 and IDF-2035

See merge request espressif/esp-idf!12963
2021-06-16 23:21:45 +00:00
..
_static
Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master'
2021-05-31 10:07:19 +00:00
doxygen
build docs: enable building of S3 docs
2021-06-09 09:30:36 +08:00
en
Merge branch 'feature/refactor_common_secure_boot_code' into 'master'
2021-06-16 23:21:45 +00:00
extensions
doc: Add support for redirects to external URL
2021-04-27 17:01:24 +08:00
idf_extensions
build docs: enable building of S3 docs
2021-06-09 09:30:36 +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 'example/ledc_pwm_basic' into 'master'
2021-06-15 11:12:46 +00:00
build_docs.py
build docs: enable building of S3 docs
2021-06-09 09:30:36 +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
build docs: enable building of S3 docs
2021-06-09 09:30:36 +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.