From b810c96e5108740f8da54eaa07e365b16dbf405a Mon Sep 17 00:00:00 2001 From: Francesco Nattino Date: Fri, 9 Feb 2024 16:13:28 +0100 Subject: [PATCH 1/5] add build section to readthedocs config --- readthedocs.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/readthedocs.yml b/readthedocs.yml index 19834bf8..caaaad21 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -1,5 +1,10 @@ version: 2 +build: + os: "ubuntu-22.04" + tools: + python: "mambaforge-latest" + sphinx: configuration: docs/source/conf.py From 6da939615188d49fdee37600442907ee3235ecdd Mon Sep 17 00:00:00 2001 From: Francesco Nattino Date: Fri, 9 Feb 2024 16:24:31 +0100 Subject: [PATCH 2/5] sphinx >=5 is required --- docs/environment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/environment.yml b/docs/environment.yml index 17435753..c6a320b1 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -6,6 +6,6 @@ dependencies: - distributed - numpydoc - ipython - - sphinx + - sphinx>=5 - pip: - dask-sphinx-theme>=3.0.0 From f3b80942346e40ecc200864c4d162a0bc0d26ca4 Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Fri, 2 Aug 2024 15:31:32 +0100 Subject: [PATCH 3/5] Add workaround to environment --- docs/environment.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/environment.yml b/docs/environment.yml index c6a320b1..4049873e 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -9,3 +9,12 @@ dependencies: - sphinx>=5 - pip: - 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 From 874972f1ebfcd75c63ae94767e94cb108a4db1c7 Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Fri, 2 Aug 2024 15:37:44 +0100 Subject: [PATCH 4/5] Switch from conda to pip to simplify dependency resolve --- docs/environment.yml | 20 -------------------- docs/requirements-docs.txt | 14 ++++++++++++++ readthedocs.yml | 12 +++++++++--- 3 files changed, 23 insertions(+), 23 deletions(-) delete mode 100644 docs/environment.yml create mode 100644 docs/requirements-docs.txt diff --git a/docs/environment.yml b/docs/environment.yml deleted file mode 100644 index 4049873e..00000000 --- a/docs/environment.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: dask-jobqueue-docs -channels: - - conda-forge -dependencies: - - python=3.8 - - distributed - - numpydoc - - ipython - - sphinx>=5 - - pip: - - 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/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 00000000..b4923de1 --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,14 @@ +distributed +numpydoc +ipython +sphinx +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/readthedocs.yml b/readthedocs.yml index caaaad21..27be5f20 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -1,17 +1,23 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + version: 2 build: os: "ubuntu-22.04" tools: - python: "mambaforge-latest" + python: "3.10" sphinx: configuration: docs/source/conf.py - -conda: environment: docs/environment.yml python: install: + - requirements: docs/requirements-docs.txt - method: pip path: . + +submodules: + include: all From e69d29f53ba6386611447a387e441830ed718338 Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Fri, 2 Aug 2024 15:39:11 +0100 Subject: [PATCH 5/5] Fix yaml issue --- readthedocs.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/readthedocs.yml b/readthedocs.yml index 27be5f20..cdd057b1 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -11,8 +11,7 @@ build: sphinx: configuration: docs/source/conf.py - environment: docs/environment.yml - + python: install: - requirements: docs/requirements-docs.txt