Skip to content

Commit cbb9593

Browse files
committed
Docs: recommend using pip instead of setuptools
- mention `pip` is the recommended way - mention `setuptools` is deprecated - remove `setuptools` from the examples in favor of `pip` Related #8659
1 parent 7de0e35 commit cbb9593

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/user/config-file/v2.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Configuration of the Python environment to be used.
160160
path: .
161161
extra_requirements:
162162
- docs
163-
- method: setuptools
163+
- method: pip
164164
path: another/package
165165
system_packages: true
166166
@@ -215,7 +215,7 @@ Example:
215215
Packages
216216
''''''''
217217

218-
Install the project using ``python setup.py install`` or ``pip install``.
218+
Install the project using ``pip install`` (recommended) or ``python setup.py install`` (deprecated).
219219

220220
The path to the package, relative to the root of the project.
221221

@@ -226,7 +226,7 @@ The path to the package, relative to the root of the project.
226226
The installation method.
227227

228228
:Key: ``method``
229-
:Options: ``pip``, ``setuptools``
229+
:Options: ``pip``, ``setuptools`` (deprecated)
230230
:Default: ``pip``
231231

232232
`Extra requirements`_ section to install in addition to the `package dependencies`_.
@@ -255,7 +255,7 @@ Example:
255255
path: .
256256
extra_requirements:
257257
- docs
258-
- method: setuptools
258+
- method: pip
259259
path: package
260260
261261
With the previous settings, Read the Docs will execute the next commands:

0 commit comments

Comments
 (0)