| Name | Date | Size | #Lines | LOC | ||
|---|---|---|---|---|---|---|
| .. | - | - | ||||
| _static/ | 11-Mar-2024 | - | 5,284 | 5,010 | ||
| doxygen/ | 11-Mar-2024 | - | 341 | 323 | ||
| en/ | 11-Mar-2024 | - | 57,769 | 38,748 | ||
| zh_CN/ | 11-Mar-2024 | - | 31,761 | 21,396 | ||
| README.md | D | 11-Mar-2024 | 1 KiB | 19 | 10 | |
| TEMPLATE_EXAMPLE_README.md | D | 11-Mar-2024 | 2.4 KiB | 63 | 35 | |
| check_lang_folder_sync.sh | D | 11-Mar-2024 | 1.1 KiB | 37 | 16 | |
| conf_common.py | D | 11-Mar-2024 | 7.8 KiB | 182 | 126 | |
| doxygen-known-warnings.txt | D | 11-Mar-2024 | 161 | 2 | 1 | |
| generate_chart.py | D | 11-Mar-2024 | 9.7 KiB | 217 | 159 | |
| page_redirects.txt | D | 11-Mar-2024 | 5.7 KiB | 85 | 76 | |
| requirements.txt | D | 11-Mar-2024 | 16 | 2 | 1 | |
| sphinx-known-warnings.txt | D | 11-Mar-2024 | 4.4 KiB | 82 | 77 |
README.md
1# Documentation Source Folder 2 3This folder contains source files of **ESP-IDF documentation** available in [English](https://docs.espressif.com/projects/esp-idf/en/latest/) and [中文](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/). 4 5The sources do not render well in GitHub and some information is not visible at all. 6 7Use actual documentation generated within about 20 minutes on each commit: 8 9# Hosted Documentation 10 11* English: https://docs.espressif.com/projects/esp-idf/en/latest/ 12* 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/ 13 14The 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. 15 16# Building Documentation 17 18The 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 19