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
Nachiket Kukade acb1143409 Add support for FTM operation 
Add FTM support for below configuration -
1. Station(connected) as Initiator with AP as responder
2. SoftAP as responder with the connected Station
Added Station example with runtime FTM configurations.
2021-01-27 10:57:41 +05:30
..
_static
Merge branch 'docs/update_docs_based_on_several_customer_feedbacks' into 'master'
2021-01-26 16:18:13 +08:00
doxygen
component/bt: add BLE v5.0 feature for bluedroid host
2021-01-15 17:55:12 +08:00
en
Add support for FTM operation
2021-01-27 10:57:41 +05:30
extensions
style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +08:00
idf_extensions
style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +08:00
latex_templates
Whitespace: Automated whitespace fixes (large commit)
2020-11-11 07:36:35 +00:00
test
style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +08:00
zh_CN
Merge branch 'feature/update_jtag_translation' into 'master'
2021-01-27 10:37:10 +08:00
build_docs.py
style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +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 hypertargets to all TRM references
2021-01-26 05:51:52 +00: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: 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
style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +08: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.