mirror of
https://github.com/espressif/esp-idf.git
synced 2026-04-27 19:13:21 +00:00
docs: Update example README template and other related docs
This commit is contained in:
+14
-2
@@ -11,8 +11,20 @@ Use actual documentation generated within about 20 minutes on each commit:
|
||||
* 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.
|
||||
After you click any link to [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/index.html), go to the top of the sidebar, then make sure you have the correct Espressif chip (target) and ESP-IDF version selected in the dropdown menus. You can also find a link on the bottom right to download the PDF version.
|
||||
|
||||
# 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
|
||||
The documentation is built using the python package `esp-docs`, which can be installed by running:
|
||||
|
||||
```
|
||||
pip install esp-docs
|
||||
```
|
||||
|
||||
For a summary of available options, run:
|
||||
|
||||
```
|
||||
build-docs --help
|
||||
```
|
||||
|
||||
For more information see the `esp-docs` documentation at https://github.com/espressif/esp-docs/blob/master/README.md
|
||||
|
||||
Reference in New Issue
Block a user