Skip to content

Commit 91230c8

Browse files
author
daniel.eades
committed
fixup
1 parent e6a9bc6 commit 91230c8

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

doc/internals/contributing.rst

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,16 +93,33 @@ 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 and install dependencies.
96+
#. Install uv and setup your environment.
9797

98-
This is not necessary for unit testing, thanks to :program:`tox`,
99-
but it is necessary if you wish to run :program:`sphinx-build` locally
100-
or run unit tests without the help of :program:`tox`:
98+
We recommend using :program:`uv` for dependency management.
99+
Install it with:
100+
101+
.. code-block:: shell
102+
103+
pip install uv
104+
105+
Then, setup your environment:
101106

102107
.. code-block:: shell
103108
104109
uv sync
105110
111+
**Alternative:** If you prefer not to use :program:`uv`, you can use
112+
:program:`pip` and :program:`virtualenv`:
113+
114+
.. code-block:: shell
115+
116+
python -m venv .venv
117+
. .venv/bin/activate
118+
pip install -e .
119+
120+
:program:`uv` is faster, provides a better development experience,
121+
and ensures a consistent environment through dependency locking.
122+
106123
#. Create a new working branch. Choose any name you like.
107124

108125
.. code-block:: shell
@@ -205,6 +222,13 @@ You can also test by installing dependencies in your local environment:
205222
206223
uv run pytest
207224
225+
Or with :program:`pip`:
226+
227+
.. code-block:: shell
228+
229+
pip install -e ".[test]"
230+
pytest
231+
208232
To run JavaScript tests, use :program:`npm`:
209233

210234
.. code-block:: shell

0 commit comments

Comments
 (0)