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.

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

Read the docs is deprecating use_system_packages #174

Open
vchendrix opened this issue Aug 7, 2023 · 0 comments
Open

Read the docs is deprecating use_system_packages #174

vchendrix opened this issue Aug 7, 2023 · 0 comments
Labels

Comments

@vchendrix
Copy link
Contributor

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant