Skip to content

Fix instructions for docs dependencies and building #486

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
Advueu963 merged 1 commit into from
Jan 7, 2026
Merged

Fix instructions for docs dependencies and building #486

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
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,13 @@ To build the documentation on your end and to check if your changes are document
need to install the documentation dependencies:

```sh
uv sync --all-extras --dev --docs
uv sync --group docs
```

Then, you can build the documentation from the root of the repository with:

```sh
sphinx-build docs/source docs/build
uv run sphinx-build docs/source docs/build
```

This will render the documentation in the `docs/build` directory. You can open the `index.html` file
Expand Down