Skip to content

Commit

Permalink
Docs: recommend using pip instead of setuptools
Browse files Browse the repository at this point in the history
- mention `pip` is the recommended way
- mention `setuptools` is deprecated
- remove `setuptools` from the examples in favor of `pip`

Related #8659
  • Loading branch information
humitos committed Aug 31, 2022
1 parent 7de0e35 commit cbb9593
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/user/config-file/v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ Configuration of the Python environment to be used.
path: .
extra_requirements:
- docs
- method: setuptools
- method: pip
path: another/package
system_packages: true
Expand Down Expand Up @@ -215,7 +215,7 @@ Example:
Packages
''''''''

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

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

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

:Key: ``method``
:Options: ``pip``, ``setuptools``
:Options: ``pip``, ``setuptools`` (deprecated)
:Default: ``pip``

`Extra requirements`_ section to install in addition to the `package dependencies`_.
Expand Down Expand Up @@ -255,7 +255,7 @@ Example:
path: .
extra_requirements:
- docs
- method: setuptools
- method: pip
path: package
With the previous settings, Read the Docs will execute the next commands:
Expand Down

0 comments on commit cbb9593

Please sign in to comment.