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

[BUG] readthedocs build deprecations #495

Open
lmeyerov opened this issue Aug 7, 2023 · 7 comments
Open

[BUG] readthedocs build deprecations #495

lmeyerov opened this issue Aug 7, 2023 · 7 comments

Comments

@lmeyerov
Copy link
Contributor

lmeyerov commented Aug 7, 2023

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
@7h3-3mp7y-m4n
Copy link

7h3-3mp7y-m4n commented Aug 7, 2023

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

@lmeyerov
Copy link
Contributor Author

lmeyerov commented Aug 7, 2023

@7h3-3mp7y-m4n
Copy link

Okay I'll look at it :)

@lmeyerov
Copy link
Contributor Author

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
Copy link
Contributor Author

If helpful, dev would pull in all these dependencies:

'dev': unique_flatten_dict(base_extras_light) + unique_flatten_dict(dev_extras),

@7h3-3mp7y-m4n
Copy link

7h3-3mp7y-m4n commented Aug 14, 2023

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

@7h3-3mp7y-m4n
Copy link

7h3-3mp7y-m4n commented Aug 14, 2023

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 

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

No branches or pull requests

2 participants