alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
0771bd1711
esp-idf/docs
History
Omar Chebib 0771bd1711 espsystem: Rearchitecture and fix eh_frame_parser bugs 
eh_frame_parser is architecture independent, thus the files have
been rearchitectured. Some bugs have been fixed in the test.
A README file has also been added to eh_frame_parser host test
directory.

eh_frame_parser is now able to detect empty gaps in .eh_frame_hdr
table (missing DWARF information).
Fix a bug occuring when parsing backtraces originated from abort().
Fix build missing dependencies issue.
2021-07-15 12:47:51 +08:00
..
_static docs: rename ESP-MESH to ESP-WIFI-MESH 2021-07-12 19:25:18 +08:00
doxygen Merge branch 'feature/add-nimble-host-to-blufi' into 'master' 2021-06-29 12:54:01 +00:00
en espsystem: Rearchitecture and fix eh_frame_parser bugs 2021-07-15 12:47:51 +08:00
extensions doc: Add support for redirects to external URL 2021-04-27 17:01:24 +08:00
idf_extensions docs: add S3 TRM URL 2021-07-12 16:39:23 +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 soc: add reset reasons in soc component 2021-07-13 10:45:38 +08: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 docs:add esp32-s3-devkitc-1 user guide 2021-07-02 15:21:07 +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 docs: rename ESP-MESH to ESP-WIFI-MESH 2021-07-12 19:25:18 +08: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: ignore duplicate def warning in BT docs 2021-06-30 15:10:43 +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.