Skip to content

Commit

Permalink
Fix reference to file in docs contributing guide (#5127)
Browse files Browse the repository at this point in the history
  • Loading branch information
zanieb authored Jul 16, 2024
1 parent 616a61a commit 47e453b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ To preview any changes to the documentation locally:
uv pip install -r docs/requirements.txt

# Or, for members of the Astral org, which has access to MkDocs Insiders via sponsorship.
uv pip install -r docs/requirements.insiders.txt
uv pip install -r docs/requirements-insiders.txt
```

1. Run the development server with:
Expand All @@ -145,11 +145,11 @@ To preview any changes to the documentation locally:
The documentation should then be available locally at
[http://127.0.0.1:8000/uv/](http://127.0.0.1:8000/uv/).

To update the documentation dependencies, edit `docs/requirements.in` and `docs/requirements.insiders.in`, then run:
To update the documentation dependencies, edit `docs/requirements.in` and `docs/requirements-insiders.in`, then run:

```shell
uv pip compile docs/requirements.in -o docs/requirements.txt --universal -p 3.12
uv pip compile docs/requirements.insiders.in -o docs/requirements.insiders.txt --universal -p 3.12
uv pip compile docs/requirements-insiders.in -o docs/requirements-insiders.txt --universal -p 3.12
```

Documentation is deployed automatically on release by publishing to the [Astral documentation](https://github.com/astral-sh/docs)
Expand Down

0 comments on commit 47e453b

Please sign in to comment.