Skip to content

docs: Simplify doc building instructions #632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ValerianRey merged 1 commit into from
Mar 13, 2026
Merged

docs: Simplify doc building instructions #632

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,16 +115,12 @@ uv run pre-commit install
> the CI runs the tests in several different environments.

### Building the documentation locally
- From the `docs` folder, run:
- Run:
```bash
uv run make html
uv run make clean -C docs
uv run make html -C docs
```
- You can then open `docs/build/html/index.html` with a web browser.
- Sometimes, you need to manually delete the built documentation before generating it. To do
this, from the `docs` folder, run:
```bash
uv run make clean
```

### Type checking

Expand Down
Loading