From cbb9593efc1f5f996b092cb245beed240812d10c Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 31 Aug 2022 13:44:17 +0200 Subject: [PATCH] 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 --- docs/user/config-file/v2.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/user/config-file/v2.rst b/docs/user/config-file/v2.rst index d5193ff0049..c29509efc85 100644 --- a/docs/user/config-file/v2.rst +++ b/docs/user/config-file/v2.rst @@ -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 @@ -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. @@ -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`_. @@ -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: