From 47e453b01a7c16aad1473b11af6ca081c6125028 Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Tue, 16 Jul 2024 16:49:46 -0400 Subject: [PATCH] Fix reference to file in docs contributing guide (#5127) --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c371dc31d..ceaaeb80b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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)