Skip to content

Commit acd50cf

Browse files
authored
docs: Simplify doc building instructions (#632)
1 parent 9c581a1 commit acd50cf

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -115,16 +115,12 @@ uv run pre-commit install
115115
> the CI runs the tests in several different environments.
116116

117117
### Building the documentation locally
118-
- From the `docs` folder, run:
118+
- Run:
119119
```bash
120-
uv run make html
120+
uv run make clean -C docs
121+
uv run make html -C docs
121122
```
122123
- You can then open `docs/build/html/index.html` with a web browser.
123-
- Sometimes, you need to manually delete the built documentation before generating it. To do
124-
this, from the `docs` folder, run:
125-
```bash
126-
uv run make clean
127-
```
128124

129125
### Type checking
130126

0 commit comments

Comments
 (0)