kopia lustrzana https://github.com/espressif/esp-idf
19 wiersze
1.0 KiB
Markdown
19 wiersze
1.0 KiB
Markdown
# Documentation Source Folder
|
|
|
|
This 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/).
|
|
|
|
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
|
|
|
|
* English: https://docs.espressif.com/projects/esp-idf/en/latest/
|
|
* 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
|
|
|
|
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
|