pygraphistry icon indicating copy to clipboard operation
pygraphistry copied to clipboard

[BUG] readthedocs build deprecations

Open lmeyerov opened this issue 1 year ago • 7 comments

Looks like we need to modify the readthedocs yml as per below:

Hello,
--
You are receving this email because your Read the Docs project is impacted by an upcoming deprecation.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.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: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 We are sending you this email because you are a maintainer of the following projects that are affected by this removal. Either using "Use system package" checkbox in the Admin UI, or the config key python.sytem_packages or python.use_system_site_packages in your .readthedocs.yaml file:graphistry-helmpygraphistryRead more about this in our Reproducible builds guide for more details.
Keep documenting,Read the Docs

Hello,
You are receving this email because your Read the Docs project is impacted by an upcoming deprecation.

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:

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
We are sending you this email because you are a maintainer of the following projects that are affected by this removal. Either using "Use system package" checkbox in the Admin UI, or the config key python.sytem_packages or python.use_system_site_packages in your .readthedocs.yaml file:

[graphistry-helm](https://readthedocs.org/projects/graphistry-helm/)

[pygraphistry](https://readthedocs.org/projects/pygraphistry/)

Read more about this in our [Reproducible builds](https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html) guide for more details.

Keep documenting,
Read the Docs

lmeyerov avatar Aug 07 '23 11:08 lmeyerov

hey I would love to work on this . Can you mark me the file location so that I can update the changes

7h3-3mp7y-m4n avatar Aug 07 '23 15:08 7h3-3mp7y-m4n

I think just this guy: https://github.com/graphistry/pygraphistry/blob/master/.readthedocs.yml

lmeyerov avatar Aug 07 '23 19:08 lmeyerov

Okay I'll look at it :)

7h3-3mp7y-m4n avatar Aug 08 '23 04:08 7h3-3mp7y-m4n

I think we want to keep the sphinx and target formats in the current https://github.com/graphistry/pygraphistry/blob/master/.readthedocs.yml , and the current extra_requirements: ... dev may take care of all the needed dependencies . So it might be a matter of trying and seeing what happens..

lmeyerov avatar Aug 10 '23 17:08 lmeyerov

If helpful, dev would pull in all these dependencies: https://github.com/graphistry/pygraphistry/blob/ebc63be22b10acdd86aabd0a0187178559a21f1d/setup.py#L59

lmeyerov avatar Aug 10 '23 17:08 lmeyerov

I'll look at it :) , And I'm sorry for my late response , I was just waiting on slack , My bad

7h3-3mp7y-m4n avatar Aug 14 '23 12:08 7h3-3mp7y-m4n

what do you say about this

# Read the Docs configuration file for Sphinx projects

version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3.10"

sphinx:
  configuration: docs/conf.py


formats:
  - pdf
  - htmlzip
  - epub

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

7h3-3mp7y-m4n avatar Aug 14 '23 12:08 7h3-3mp7y-m4n