Skip to content

Commit 76b01e3

Browse files
committed
Post: Drop support for "Use system packages"
Announcement of readthedocs/readthedocs.org#10562
1 parent 2b61915 commit 76b01e3

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

drop-support-system-packages.rst

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. post:: August 8, 2023
2+
:tags: builders
3+
:author: Manuel
4+
:location: BCN
5+
:category: Changelog
6+
7+
Drop support for "Use system packages"
8+
======================================
9+
10+
You are receving this email because your Read the Docs project is impacted by an upcoming deprecation.
11+
12+
Read the Docs used to pre-install common scientific Python packages like ``scipy``, ``numpy``, ``pandas``, ``matplotlib`` and others
13+
at system level to speed up the build process.
14+
However, with all the work done in the Python ecosystem and the introduction of "wheels",
15+
these packages are a lot easier to install via ``pip install`` and these pre-installed packages are not required anymore.
16+
If you have Apt package dependencies,
17+
they can be installed with `build.apt_packages <https://docs.readthedocs.io/en/stable/config-file/v2.html#build-apt-packages>`_.
18+
19+
With the introduction of our new "Ubuntu 20.04" and "Ubuntu 22.04" Docker images,
20+
we stopped pre-installing these extra Python packages and we encouraged users to install and pin all their dependencies using a ``requirements.txt`` file.
21+
We have already stopped supporting "use system packages" on these newer images.
22+
23+
**We are removing the "use system packages" feature on August 29th**.
24+
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``.
25+
26+
Here you have an example of the section required on the ``.readthedocs.yaml`` configuration file:
27+
28+
.. code-block:: yaml
29+
30+
python:
31+
install:
32+
- requirements: docs/requirements.txt
33+
34+
35+
The content of ``docs/requirements.txt`` would be similar to::
36+
37+
scipy==1.11.1
38+
numpy==1.25.2
39+
pandas==2.0.3
40+
matplotlib==3.7.2
41+
42+
Read more about this in our :doc:`introduction to Reproducible Builds <readthedocs:guides/reproducible-builds>` guide for more details.
43+
44+
Please, `contact us`_ and let us know any inconvenient you may have with this change.
45+
46+
.. _contact us: mailto:[email protected]

0 commit comments

Comments
 (0)