mirror of
https://github.com/espressif/esp-idf.git
synced 2026-04-27 11:03:11 +00:00
Merge branch 'docs/fix_doc_access_html' into 'master'
docs: Change PDF to HTML in access description Closes DOC-13022 See merge request espressif/esp-idf!45425
This commit is contained in:
+9
-7
@@ -1,21 +1,23 @@
|
||||
* [中文版](./README_CN.md)
|
||||
|
||||
# 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/).
|
||||
This folder contains source files of **ESP-IDF documentation** available in [English](https://docs.espressif.com/projects/esp-idf/en/latest/) and [Chinese](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.
|
||||
The sources do not render well in GitHub and some information is not visible without building the documentation.
|
||||
|
||||
Use actual documentation generated within about 20 minutes on each commit:
|
||||
Use the actual documentation, which is generated within about 20 minutes of each commit:
|
||||
|
||||
# Hosted Documentation
|
||||
|
||||
* English: https://docs.espressif.com/projects/esp-idf/en/latest/
|
||||
* 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
|
||||
* Chinese: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
|
||||
|
||||
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.
|
||||
After clicking 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 at the bottom right to download the HTML version.
|
||||
|
||||
# Building Documentation
|
||||
|
||||
The documentation is built using the python package `esp-docs`, which can be installed by running:
|
||||
The documentation is built using the Python package `esp-docs`, which can be installed by running:
|
||||
|
||||
```
|
||||
pip install esp-docs
|
||||
@@ -27,4 +29,4 @@ 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
|
||||
For more information, see the `esp-docs` documentation at https://github.com/espressif/esp-docs/blob/master/README.md
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
* [English Version](./README.md)
|
||||
|
||||
# 文档源文件夹
|
||||
|
||||
本文件夹包含 **ESP-IDF 文档**的源文件,提供[英文版](https://docs.espressif.com/projects/esp-idf/en/latest/)和[中文版](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/)。
|
||||
|
||||
这些源文件在 GitHub 上的渲染效果不佳,某些信息只有在构建文档后才能显示。
|
||||
|
||||
请使用每次提交后约 20 分钟内生成的实际文档:
|
||||
|
||||
# 在线文档
|
||||
|
||||
* 英文: https://docs.espressif.com/projects/esp-idf/en/latest/
|
||||
* 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
|
||||
|
||||
在您点击任何链接访问 [ESP-IDF 编程指南](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/index.html)后,请前往侧边栏顶部,确保在下拉菜单中选择了正确的乐鑫芯片(目标)和 ESP-IDF 版本。您还可以在页面右下角找到下载 HTML 版本的链接。
|
||||
|
||||
# 构建文档
|
||||
|
||||
文档使用 Python 包 `esp-docs` 构建,可以通过运行以下命令安装:
|
||||
|
||||
```
|
||||
pip install esp-docs
|
||||
```
|
||||
|
||||
要查看可用选项的摘要,请运行:
|
||||
|
||||
```
|
||||
build-docs --help
|
||||
```
|
||||
|
||||
更多信息请参阅 `esp-docs` 文档:https://github.com/espressif/esp-docs/blob/master/README.md
|
||||
Reference in New Issue
Block a user