Skip to content

Commit 78bbb91

Browse files
committed
Final changes
1 parent 2365ecc commit 78bbb91

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/source/community/contributing.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ Now that you have the repository locally, you need to set up a Python environmen
9898
:::
9999

100100
::::
101+
If you also want to edit the documentation and preview the changes locally, you will additionally need the `docs` extra dependencies. See [Editing the documentation](#editing-the-documentation) for more details.
101102

102103
2. Finally, initialise the [pre-commit hooks](#formatting-and-pre-commit-hooks):
103104

@@ -271,8 +272,8 @@ To edit the documentation, ensure you have already set up a [development environ
271272

272273
To build the documentation locally, install the extra dependencies by running the following command from the repository root:
273274
```sh
274-
pip install -r ./docs/requirements.txt # conda env
275-
uv pip install -r ./docs/requirements.txt # uv env
275+
pip install -e ".[docs]" # conda env
276+
uv pip install -e ".[docs]" # uv env
276277
```
277278

278279
Now create a new branch, edit the documentation source files (`.md` or `.rst` in the `docs` folder),

0 commit comments

Comments
 (0)