Skip to content

Commit 00100b0

Browse files
committed
Merge branch 'docs-readme' into 'main'
docs: simplify the README for building docs See merge request app-frameworks/esp-matter!1217
2 parents c7b9ef8 + 5022bba commit 00100b0

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,20 @@ The above URL is for the main branch latest version. Click the drop-down in the
1414

1515
# Building Documentation
1616

17-
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
17+
This project uses [esp-docs](https://docs.espressif.com/projects/esp-docs/en/latest/index.html) to build the documentation.
18+
19+
- Install dependencies
20+
```
21+
pip install -r requirements.txt
22+
```
23+
24+
- Build documentation
25+
```
26+
build-docs -bs html latex -t esp32 -l en
27+
```
28+
NOTE: Above command only builds for the `esp32` target, you can add more targets to `-t` argument.
29+
30+
- For more available options run:
31+
```
32+
build-docs --help
33+
```

0 commit comments

Comments
 (0)