Martin Vychodil 3b3bfc1971 Merge branch 'vfs_fat/improve_mount_function_names' into 'master' 3 rokov pred
..
_static 57ac6d4673 docs: update s3-devkitc-1 user guide 3 rokov pred
docs_not_updated fe9c6cde4f spi: support spi on h2 3 rokov pred
doxygen 60bb5c913d clk_tree: prework of introducing clk subsystem control 3 rokov pred
en 3b3bfc1971 Merge branch 'vfs_fat/improve_mount_function_names' into 'master' 3 rokov pred
zh_CN 3b3bfc1971 Merge branch 'vfs_fat/improve_mount_function_names' into 'master' 3 rokov pred
README.md 7411321603 docs: update to use esp-docs 4 rokov pred
TEMPLATE_EXAMPLE_README.md 5f7733f692 docs: update frontpage/general pages for ESP8684 4 rokov pred
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 rokov pred
conf_common.py 6514f9e94c docs: translate coexist from CN to EN 4 rokov pred
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 rokov pred
page_redirects.txt 795b7ed993 esp_netif: Remove tcpip_adapter compatibility layer 4 rokov pred
requirements.txt a4c71c47fc docs: update esp-docs version to 0.2.4 3 rokov pred
sphinx-known-warnings.txt e07be3df49 docs: ignore duplicate def warning in BT docs 4 rokov pred

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 is built using the python package esp-docs, which can be installed by running pip install esp-docs. Running build-docs --help will give a summary of available options. For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md