Skip to content

Commit 6401484

Browse files
roxellbhcopeland
authored andcommitted
docs: update build instructions for zensical and uv
Add uv-based workflow for building docs locally. Update pip instructions to match the new tool. Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
1 parent 43f7fda commit 6401484

1 file changed

Lines changed: 20 additions & 15 deletions

File tree

docs/index.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,14 @@ More details on test-runner usage in [test-runner docs](test-runner.md)
9090
## Generating documentation
9191

9292
[Full docs](https://test-definitions.readthedocs.io) are generated from existing
93-
YAML files. Resulting markdown files are not stored in the repository. In order
94-
to generate documentation locally one needs to follow the steps below:
93+
YAML files. Resulting markdown files are not stored in the repository.
94+
95+
### Using uv
96+
97+
uv run --with pyyaml --with zensical -- python generate_test_docs.py
98+
uv run --with zensical -- zensical serve
99+
100+
### Using pip
95101

96102
1. create and activate virtualenv
97103
```
@@ -106,19 +112,18 @@ to generate documentation locally one needs to follow the steps below:
106112
```
107113
python generate_test_docs.py
108114
```
109-
4. run mkdocs
110-
* local http server
111-
```
112-
mkdocs serve
113-
```
114-
This will start small http server on http://127.0.0.1:8000
115-
116-
* build static docs
117-
```
118-
mkdocs build
119-
```
120-
This will convert all generated markdown files to HTML files. By default
121-
files are stored in 'site' directory.
115+
4. run zensical
116+
```
117+
zensical serve
118+
```
119+
120+
This will start a local http server on http://127.0.0.1:8000.
121+
122+
To build static HTML instead:
123+
124+
zensical build
125+
126+
Files are stored in the 'site' directory.
122127

123128
## Contributing
124129

0 commit comments

Comments
 (0)