Skip to content

Deprecation: remove "use system packages" (python.system_packages config key and UI checkbox) #10562

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

Merged
merged 9 commits into from
Aug 22, 2023
Merged

Deprecation: remove "use system packages" (python.system_packages config key and UI checkbox) #10562

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9275a56
Docs: do not mention `python.system_packages`
humitos Jul 24, 2023
c513568
Build: remove "use system package" option
humitos Aug 3, 2023
82b5ec4
Merge branch 'main' into humitos/config-system-packages
humitos Aug 3, 2023
6b0230c
Do not remove the DB field for now
humitos Aug 3, 2023
75bcc32
Remove `use_system_site_packages` leftovers
humitos Aug 3, 2023
4561971
Display custom error messages based on the config key
humitos Aug 3, 2023
26d0748
Apply suggestions from code review
humitos Aug 7, 2023
cebb79e
Minor code style changes
humitos Aug 7, 2023
71904ad
Update readthedocs/config/config.py
humitos Aug 9, 2023
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
17 changes: 0 additions & 17 deletions docs/user/config-file/v2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,6 @@ Configuration of the Python environment to be used.
- docs
- method: pip
path: another/package
system_packages: true

python.version
``````````````
Expand Down Expand Up @@ -228,20 +227,6 @@ With the previous settings, Read the Docs will execute the next commands:

pip install .[docs]

python.system_packages
``````````````````````

Give the virtual environment access to the global site-packages directory.

:Type: ``bool``
:Default: ``false``

.. warning::

If you are using a :ref:`Conda <config-file/v2:conda>` environment
to manage the build, this setting will not have any effect, since
the virtual environment creation is managed by Conda.

conda
~~~~~

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

.. warning::
Expand Down