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