blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-10 09:39:10 -04:00
Code Issues Projects Releases Wiki Activity
esp-idf/docs
History
David Cermak 9459c0dd43 asio: Basic SSL/TLS support in asio port for ESP platform 
This port employs IDF port of OpenSSL for most common features, others
are discouraged or not supported. The port also introduces several stubs
for OpenSSL functions which ASIO needs to get compiled and linked.

Upstream ASIO supports WolfSSL as SSL/TLS stack, as well, which is
another option for SSL support in ASIO on ESP platform.
2020-07-14 10:42:17 +00:00
..
_static
TWAI: Add ESP32-S2 support
2020-06-30 16:56:03 +08:00
en
asio: Basic SSL/TLS support in asio port for ESP platform
2020-07-14 10:42:17 +00:00
extensions
doc: custom list filter directive
2020-02-20 18:08:05 +08:00
idf_extensions
docs: fix link_roles not linking correctly for certain files
2020-06-22 20:42:59 +08:00
latex_templates
doc: add latex and PDF generation to build_docs
2020-04-15 17:14:22 +08:00
zh_CN
httpd_resp_send: use HTTPD_RESP_USE_STRLEN when possible
2020-07-13 05:34:56 +00:00
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
spi_slave_hd: new driver for spi slave in half duplex mode
2020-07-11 00:00:50 +08:00
Doxyfile
spi_slave_hd: new driver for spi slave in half duplex mode
2020-07-11 00:00:50 +08:00
doxygen-known-warnings.txt
docs: Resolve doxygen & Sphinx warnings
2020-02-07 16:37:45 +11: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
TWAI: Add ESP32-S2 support
2020-06-30 16:56:03 +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: update sphinx_idf_theme documentation
2020-07-06 10:45:43 +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: fix check_docs not working for multiple builders
2020-05-29 20:10:18 +08:00
TEMPLATE_EXAMPLE_README.md
…

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.