From 5dbc4b9e69497fd9235eb43572bbda842700ea61 Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Tue, 14 Oct 2025 11:38:14 +0100 Subject: [PATCH 1/4] Fixes for Sphinx 8 --- .gitignore | 1 + docs/requirements-docs.txt | 11 +---------- docs/source/conf.py | 5 ++--- 3 files changed, 4 insertions(+), 13 deletions(-) diff --git a/.gitignore b/.gitignore index dfd680b3..814fcde2 100644 --- a/.gitignore +++ b/.gitignore @@ -137,3 +137,4 @@ ci/slurm/environment.yml ci/pbs/environment.yml ci/sge/environment.yml ci/htcondor/environment.yml +docs/generated/ diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index e79e74ae..e0161991 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,15 +1,6 @@ distributed numpydoc ipython -sphinx<5 +sphinx>=8 sphinx-reredirects dask-sphinx-theme>=3.0.0 -# FIXME: This workaround is required until we have sphinx>=5, as enabled by -# dask-sphinx-theme no longer pinning sphinx-book-theme==0.2.0. This is -# tracked in https://github.com/dask/dask-sphinx-theme/issues/68. -# -sphinxcontrib-applehelp<1.0.5 -sphinxcontrib-devhelp<1.0.6 -sphinxcontrib-htmlhelp<2.0.5 -sphinxcontrib-serializinghtml<1.1.10 -sphinxcontrib-qthelp<1.0.7 diff --git a/docs/source/conf.py b/docs/source/conf.py index 4a08afb8..0da13de3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -40,7 +40,6 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.mathjax"] extensions = [ "sphinx.ext.autodoc", "sphinx.ext.mathjax", @@ -210,6 +209,6 @@ # Link to GitHub issues and pull requests using :pr:`1234` and :issue:`1234` # syntax extlinks = { - "issue": ("https://github.com/dask/dask-jobqueue/issues/%s", "GH#"), - "pr": ("https://github.com/dask/dask-jobqueue/pull/%s", "GH#"), + "issue": ("https://github.com/dask/dask-jobqueue/issues/%s", "GH#%s"), + "pr": ("https://github.com/dask/dask-jobqueue/pull/%s", "GH#%s"), } From b031d09d0a27671c567347ce0b3b1715ecce6c7d Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Tue, 14 Oct 2025 11:42:44 +0100 Subject: [PATCH 2/4] Linting fixes --- dask_jobqueue/core.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dask_jobqueue/core.py b/dask_jobqueue/core.py index f62a5055..a918706f 100644 --- a/dask_jobqueue/core.py +++ b/dask_jobqueue/core.py @@ -663,7 +663,7 @@ def __init__( job_kwargs["interface"] = interface job_kwargs["protocol"] = protocol job_kwargs["security"] = self._get_worker_security(security) - + self.queue = queue if queue is not None: job_kwargs["queue"] = queue From 535e9efe0e96ec733e169f127d2297fd11aa9da8 Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Tue, 14 Oct 2025 11:54:40 +0100 Subject: [PATCH 3/4] Ensure latest dask-sphinx-theme --- docs/requirements-docs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index e0161991..691a7937 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -3,4 +3,4 @@ numpydoc ipython sphinx>=8 sphinx-reredirects -dask-sphinx-theme>=3.0.0 +dask-sphinx-theme>=4.0.0 From 174d650823cf21ac3d7cd8ca1640d2156178b047 Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Tue, 14 Oct 2025 11:58:23 +0100 Subject: [PATCH 4/4] Update Python version in docs builds --- readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readthedocs.yml b/readthedocs.yml index cdd057b1..7b8032d1 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -7,7 +7,7 @@ version: 2 build: os: "ubuntu-22.04" tools: - python: "3.10" + python: "3.12" sphinx: configuration: docs/source/conf.py