Skip to content

Commit e6a9bc6

Browse files
author
daniel.eades
committed
chore: recommend UV for local development
1 parent c043841 commit e6a9bc6

File tree

2 files changed

+1779
-5
lines changed

2 files changed

+1779
-5
lines changed

doc/internals/contributing.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,17 +93,15 @@ These are the basic steps needed to start developing on Sphinx.
9393
git clone https://github.com/<USERNAME>/sphinx
9494
cd sphinx
9595
96-
#. Setup a virtual environment.
96+
#. Setup a virtual environment and install dependencies.
9797

9898
This is not necessary for unit testing, thanks to :program:`tox`,
9999
but it is necessary if you wish to run :program:`sphinx-build` locally
100100
or run unit tests without the help of :program:`tox`:
101101

102102
.. code-block:: shell
103103
104-
virtualenv ~/.venv
105-
. ~/.venv/bin/activate
106-
pip install -e .
104+
uv sync
107105
108106
#. Create a new working branch. Choose any name you like.
109107

@@ -205,7 +203,7 @@ You can also test by installing dependencies in your local environment:
205203

206204
.. code-block:: shell
207205
208-
pip install . --group test
206+
uv run pytest
209207
210208
To run JavaScript tests, use :program:`npm`:
211209

0 commit comments

Comments
 (0)