mirror of
https://github.com/astral-sh/uv.git
synced 2025-10-01 22:41:16 +00:00
Add contributor documentation for the docs (#5108)
This commit is contained in:
parent
ca85767aff
commit
eb48a8ece2
1 changed files with 43 additions and 0 deletions
|
@ -112,6 +112,49 @@ You can enable `trace` level logging using the `RUST_LOG` environment variable,
|
|||
RUST_LOG=trace uv
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
To preview any changes to the documentation locally:
|
||||
|
||||
1. Install the [Rust toolchain](https://www.rust-lang.org/tools/install).
|
||||
|
||||
1. Run `cargo dev generate-all`, to update any auto-generated documentation.
|
||||
|
||||
1. Install MkDocs and Material for MkDocs with:
|
||||
|
||||
```shell
|
||||
uv venv
|
||||
|
||||
# For contributors.
|
||||
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
|
||||
```
|
||||
|
||||
1. Run the development server with:
|
||||
|
||||
```shell
|
||||
# For contributors.
|
||||
mkdocs serve -f mkdocs.public.yml
|
||||
|
||||
# For members of the Astral org, which has access to MkDocs Insiders via sponsorship.
|
||||
mkdocs serve -f mkdocs.insiders.yml
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
Documentation is deployed automatically on release by publishing to the [Astral documentation](https://github.com/astral-sh/docs)
|
||||
repository, which itself deploys via Cloudflare Pages.
|
||||
|
||||
## Releases
|
||||
|
||||
Releases can only be performed by Astral team members.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue