mirror of
https://github.com/espressif/esp-matter.git
synced 2026-04-27 19:13:13 +00:00
Merge branch 'docs-readme' into 'main'
docs: simplify the README for building docs See merge request app-frameworks/esp-matter!1217
This commit is contained in:
+17
-1
@@ -14,4 +14,20 @@ The above URL is for the main branch latest version. Click the drop-down in the
|
||||
|
||||
# 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
|
||||
This project uses [esp-docs](https://docs.espressif.com/projects/esp-docs/en/latest/index.html) to build the documentation.
|
||||
|
||||
- Install dependencies
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
- Build documentation
|
||||
```
|
||||
build-docs -bs html latex -t esp32 -l en
|
||||
```
|
||||
NOTE: Above command only builds for the `esp32` target, you can add more targets to `-t` argument.
|
||||
|
||||
- For more available options run:
|
||||
```
|
||||
build-docs --help
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user