Skip to content

Commit f4e3b10

Browse files
Update docs theme and remove docs env pins (#963)
1 parent 1daa175 commit f4e3b10

File tree

6 files changed

+10
-23
lines changed

6 files changed

+10
-23
lines changed

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ formats: all
1414
build:
1515
os: ubuntu-22.04
1616
tools:
17-
python: "3.10"
17+
python: "3.12"
1818

1919
python:
2020
install:

docs/requirements-docs.txt

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,5 @@ numpydoc
22
sphinx
33
sphinx-reredirects
44
sphinxcontrib-mermaid
5-
dask-sphinx-theme>=3.0.0
5+
dask-sphinx-theme>=4.0.0
66
sphinx-helm>=0.2.1
7-
8-
# FIXME: This workaround is required until we have sphinx>=5, as enabled by
9-
# dask-sphinx-theme no longer pinning sphinx-book-theme==0.2.0. This is
10-
# tracked in https://github.com/dask/dask-sphinx-theme/issues/68.
11-
#
12-
sphinxcontrib-applehelp<1.0.5
13-
sphinxcontrib-devhelp<1.0.6
14-
sphinxcontrib-htmlhelp<2.0.5
15-
sphinxcontrib-serializinghtml<1.1.10
16-
sphinxcontrib-qthelp<1.0.7

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
#
8080
# This is also used if you do content translation via gettext catalogs.
8181
# Usually you set "language" from the command line for these cases.
82-
language = None
82+
language = "en"
8383

8484
# List of patterns, relative to source directory, that match files and
8585
# directories to ignore when looking for source files.
@@ -112,7 +112,7 @@
112112
# Add any paths that contain custom static files (such as style sheets) here,
113113
# relative to this directory. They are copied after the builtin static files,
114114
# so a file named "default.css" will overwrite the builtin "default.css".
115-
html_static_path = ["_static"]
115+
html_static_path = []
116116

117117
# Custom sidebar templates, must be a dictionary that maps document names
118118
# to template names.

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ What is the operator?
5858
The Dask Operator is a set of custom resources and a controller that runs on your Kubernetes cluster and allows you to create and manage your Dask clusters as Kubernetes resources.
5959
Creating clusters can either be done via the :doc:`Kubernetes API with kubectl <operator_resources>` or the :doc:`Python API with KubeCluster <operator_kubecluster>`.
6060

61-
To :doc:`install the operator <operator_installation>` you need to apply some custom resource definitions that allow us to describe Dask resources and the operator itself which is a small Python application that
61+
To :doc:`install the operator <installing>` you need to apply some custom resource definitions that allow us to describe Dask resources and the operator itself which is a small Python application that
6262
watches the Kubernetes API for events related to our custom resources and creates other resources such as ``Pods`` and ``Services`` accordingly.
6363

6464
What resources does the operator manage?
65-
---------------------------------------
65+
----------------------------------------
6666

6767
The operator manages a hierarchy of resources, some custom resources to represent Dask primitives like clusters and worker groups, and native Kubernetes resources such as pods and services to run the cluster processes and facilitate communication.
6868

docs/source/kubecluster_migrating.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The classic ``KubeCluster`` class has been replaced with a new version that is b
77
Installing the operator
88
-----------------------
99

10-
To use the new implementation of ``KubeCluster`` you need to :doc:`install the Dask operator custom resources and controller <operator_installation>`.
10+
To use the new implementation of ``KubeCluster`` you need to :doc:`install the Dask operator custom resources and controller <installing>`.
1111

1212
The custom resources allow us to describe our Dask cluster components as native Kubernetes resources rather than directly creating ``Pod`` and ``Service`` resources like the classic implementation does.
1313

docs/source/operator_extending.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,8 @@ Then you need to ensure that your ``pyproject.toml`` registers the plugin as a `
9393

9494
.. code-block:: toml
9595
96-
...
97-
98-
[option.entry_points]
99-
dask_operator_plugin =
100-
my_controller_plugin = my_controller_plugin.plugin
96+
[option.entry-points.dask_operator_plugin]
97+
my_controller_plugin = "my_controller_plugin.plugin"
10198
10299
Then you can package this up and push it to your preferred Python package repository.
103100

@@ -115,7 +112,7 @@ The controller uses the ``ghcr.io/dask/dask-kubernetes-operator:latest`` contain
115112
116113
RUN pip install my-controller-plugin
117114
118-
Then when you :doc:`install the controller deployment <operator_installation>` either via the manifest or with helm you would specify your custom container image instead.
115+
Then when you :doc:`install the controller deployment <installing>` either via the manifest or with helm you would specify your custom container image instead.
119116

120117
.. code-block:: bash
121118

0 commit comments

Comments
 (0)