Skip to content

Commit 9275a56

Browse files
committed
Docs: do not mention python.system_packages
This option doesn't work on builds using `build.os` because the Python binary used it's not the one from the system, but another one compiled via `asdf`. This means that creating a virtualenv with access to the "system packages" has no effect at all. As a first step, I'm removing this option from the documentation to avoid confusions. Next, we should probably our deprecation policy to contact users ands remove it from the code as well. Closes #10500
1 parent 3eae8f5 commit 9275a56

File tree

1 file changed

+0
-17
lines changed

1 file changed

+0
-17
lines changed

docs/user/config-file/v2.rst

-17
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,6 @@ Configuration of the Python environment to be used.
130130
- docs
131131
- method: pip
132132
path: another/package
133-
system_packages: true
134133
135134
python.version
136135
``````````````
@@ -228,20 +227,6 @@ With the previous settings, Read the Docs will execute the next commands:
228227

229228
pip install .[docs]
230229

231-
python.system_packages
232-
``````````````````````
233-
234-
Give the virtual environment access to the global site-packages directory.
235-
236-
:Type: ``bool``
237-
:Default: ``false``
238-
239-
.. warning::
240-
241-
If you are using a :ref:`Conda <config-file/v2:conda>` environment
242-
to manage the build, this setting will not have any effect, since
243-
the virtual environment creation is managed by Conda.
244-
245230
conda
246231
~~~~~
247232

@@ -868,8 +853,6 @@ Changes
868853
- The settings ``python.setup_py_install`` and ``python.pip_install`` were replaced by ``python.install``.
869854
And now it accepts a path to the package.
870855
See :ref:`config-file/v2:Packages`.
871-
- The setting ``python.use_system_site_packages`` was renamed to ``python.system_packages``.
872-
See :ref:`config-file/v2:python.system_packages`.
873856
- The build will fail if there are invalid keys (strict mode).
874857

875858
.. warning::

0 commit comments

Comments
 (0)