Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix reference to file in docs contributing guide (#5127)

This commit is contained in:
Zanie Blue 2024-07-16 16:49:46 -04:00 committed by GitHub
parent 616a61a244
commit 47e453b01a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -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:
@ -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)