esp-idf/docs
kapil.gupta 179292f9b3 esp_wifi: Remove auth_changed event and fix wpa2 authmode threshold
Added following as part of this change
1. Removed auth_changed event
2. Updated doc regarding usage of  WPA/WEP secuiry modes
3. Fixed WPA2 enterprise authmode threshold.
2020-06-04 17:54:26 +05:30
..
_static Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master' 2020-05-28 02:25:47 +08:00
en esp_wifi: Remove auth_changed event and fix wpa2 authmode threshold 2020-06-04 17:54:26 +05:30
extensions
idf_extensions Merge branch 'doc/view_github_link' into 'master' 2020-05-25 03:21:23 +08:00
latex_templates doc: add latex and PDF generation to build_docs 2020-04-15 17:14:22 +08:00
zh_CN Merge branch 'doc/ds_S2' into 'master' 2020-06-04 16:36:13 +08:00
Doxyfile Doc: DS documentation for S2 2020-06-04 10:49:22 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py docs: fix check_docs not working for multiple builders 2020-05-29 20:10:18 +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 Doc: DS documentation for S2 2020-06-04 10:49:22 +08:00
doxygen-known-warnings.txt
get_github_rev.py docs: add 'edit-on-github' link to html theme 2020-05-06 17:25:23 +08:00
page_redirects.txt Add redirect link from user-guide-kaluga-1-v1.2 to user-guide-esp32-s2-kaluga-1-kit 2020-05-18 17:28:03 +08:00
requirements.txt doc: update CI to build PDF 2020-04-15 17:14:27 +08:00
sanitize_version.py
sphinx-known-warnings.txt docs: fix check_docs not working for multiple builders 2020-05-29 20:10:18 +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.