Skip to content

Commit

Permalink
docs(contributing): mention need to enable venv
Browse files Browse the repository at this point in the history
  • Loading branch information
mkniewallner committed Jul 18, 2024
1 parent b7f7a53 commit 210331c
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,21 @@ To preview any changes to the documentation locally:

# 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. Activate the virtual environment with:

```shell
# On macOS and Linux.
source .venv/bin/activate
# On Windows.
.venv\Scripts\activate
```

1. Run the development server with:

```shell
Expand Down

0 comments on commit 210331c

Please sign in to comment.