search

BASIN-3D / basin3d

The core BASIN-3D application that uses a generalized data synthesis model that applies across a variety of earth science observation types (hydrology, geochemistry, climate etc.). https://basin3d.readthedocs.io/
Other
12 stars 4 forks source link

Read the docs is deprecating use_system_packages #174

Open vchendrix opened 1 year ago

vchendrix commented 1 year ago

With the introduction of Read the Docs new "Ubuntu 20.04" and "Ubuntu 22.04" Docker images, they stopped pre-installing extra Python packages and encourage users to install and pin all their dependencies using a requirements.txt file. Read the docs has already stopped supporting "use system packages" on newer images.

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

Here is an example of the section required on the .readthedocs.yaml configuration file:

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

Currently using the config key python.sytem_packages or python.use_system_site_packages in the .readthedocs.yaml file: