dask / dask-jobqueue

Deploy Dask on job schedulers like PBS, SLURM, and SGE
https://jobqueue.dask.org
BSD 3-Clause "New" or "Revised" License
235 stars 142 forks source link

Fix readthedocs build #626

Closed fnattino closed 3 months ago

fnattino commented 9 months ago

build.os is now required in the readthedocs configuration file: https://blog.readthedocs.com/use-build-os-config/

guillaumeeb commented 9 months ago

Thanks, I wanted to look at this too. Unfortunately it is still failing.

fnattino commented 9 months ago

Apologies for the "intrusion", I noticed this failing in #623 and I thought I would help with some housekeeping with what I thought would be a quick fix 😄 .

Now readthedocs starts building, but it fails because sphinx >=5 is required by numpydoc. I tried to add the version requirement to docs/environment.yml, but somehow this is bypassed by readthedocs? https://readthedocs.org/projects/dask-jobqueue/builds/23397606/

I could maybe try to drop conda and switch to pip, also updating Python version (right now it is pinned to 3.8)?

jacobtomlinson commented 9 months ago

This workaround from https://github.com/dask/dask-sphinx-theme/issues/68#issuecomment-1893198477 is probably also needed here.

jacobtomlinson commented 3 months ago

This appears to have gone stale so I pushed a few commits to get it over the line, hope you don't mind @fnattino. The docs are now building successfully so I'm going to merge this in.