Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: recommend using pip instead of setuptools #9567

Merged
merged 1 commit into from
Sep 5, 2022
+4 −4
Merged

Docs: recommend using pip instead of setuptools #9567

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/user/config-file/v2.rst
View file
Open in desktop
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