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

Post: Drop support for "Use system packages" #235

Merged
merged 2 commits into from
Aug 8, 2023
Merged

Post: Drop support for "Use system packages" #235

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76b01e3
Post: Drop support for "Use system packages"
humitos Aug 7, 2023
89cf8f5
Update drop-support-system-packages.rst
humitos Aug 7, 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
45 changes: 45 additions & 0 deletions drop-support-system-packages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
.. post:: August 8, 2023
:tags: builders
:author: Manuel
:location: BCN
:category: Changelog

Drop support for "Use system packages"
======================================


Read the Docs used to pre-install common scientific Python packages like ``scipy``, ``numpy``, ``pandas``, ``matplotlib`` and others
at system level to speed up the build process.
However, with all the work done in the Python ecosystem and the introduction of "wheels",
these packages are a lot easier to install via ``pip install`` and these pre-installed packages are not required anymore.
If you have Apt package dependencies,
they can be installed with `build.apt_packages <https://docs.readthedocs.io/en/stable/config-file/v2.html#build-apt-packages>`_.

With the introduction of our new "Ubuntu 20.04" and "Ubuntu 22.04" Docker images,
we stopped pre-installing these extra Python packages and we encouraged users to install and pin all their dependencies using a ``requirements.txt`` file.
We have already stopped supporting "use system packages" on these newer images.

**We are removing the "use system packages" feature on August 29th**.
Make sure you are installing all the required dependecies to build your project's documentation using a ``requirements.txt`` file and specifying it in your ``.readthedocs.yaml``.

Here you have an example of the section required on the ``.readthedocs.yaml`` configuration file:

.. code-block:: yaml

python:
install:
- requirements: docs/requirements.txt


The content of ``docs/requirements.txt`` would be similar to::

scipy==1.11.1
numpy==1.25.2
pandas==2.0.3
matplotlib==3.7.2

Read more about this in our :doc:`introduction to Reproducible Builds <readthedocs:guides/reproducible-builds>` guide for more details.

Please, `contact us`_ and let us know any inconvenient you may have with this change.

.. _contact us: mailto:[email protected]