Skip to content

Commit cd66dfd

Browse files
Update docs theme and remove docs env pins (#9125)
1 parent c9e7aca commit cd66dfd

File tree

6 files changed

+17
-23
lines changed

6 files changed

+17
-23
lines changed

docs/requirements.txt

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,8 @@ tornado
33
toolz
44
cloudpickle
55
git+https://github.com/dask/dask
6-
sphinx
7-
dask-sphinx-theme>=3.0.0
8-
# FIXME: `sphinxcontrib-*` pins are a workaround until we have sphinx>=5.
9-
# See https://github.com/dask/dask-sphinx-theme/issues/68.
10-
sphinxcontrib-applehelp>=1.0.0,<1.0.7
11-
sphinxcontrib-devhelp>=1.0.0,<1.0.6
12-
sphinxcontrib-htmlhelp>=2.0.0,<2.0.5
13-
sphinxcontrib-serializinghtml>=1.1.0,<1.1.10
14-
sphinxcontrib-qthelp>=1.0.0,<1.0.7
6+
sphinx>=8.0.0
7+
dask-sphinx-theme>=4.0.0
158
sphinx-click
169
memray
1710
sphinx_design

docs/source/active_memory_manager.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ causes increased overall memory usage across the cluster.
2828

2929
Enabling the Active Memory Manager
3030
----------------------------------
31-
The AMM is enabled by default. It can be disabled or tweaked through the :doc:`Dask
31+
The AMM is enabled by default. It can be disabled or tweaked through the :external+dask:doc:`Dask
3232
configuration file <configuration>`:
3333

3434
.. code-block:: yaml

docs/source/api.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The client connects to and submits computation to a Dask cluster (such as a :cla
6161

6262
.. autosummary::
6363
as_completed
64-
distributed.diagnostics.progressbar.progress
64+
diagnostics.progressbar.progress
6565
wait
6666
fire_and_forget
6767
futures_of
@@ -73,10 +73,10 @@ The client connects to and submits computation to a Dask cluster (such as a :cla
7373
**Utilities**
7474

7575
.. autosummary::
76-
distributed.utils.Log
77-
distributed.utils.Logs
78-
distributed.diagnostics.memray.memray_scheduler
79-
distributed.diagnostics.memray.memray_workers
76+
utils.Log
77+
utils.Logs
78+
diagnostics.memray.memray_scheduler
79+
diagnostics.memray.memray_workers
8080

8181

8282
Asynchronous methods

docs/source/conf.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
from __future__ import annotations
22

3+
from pathlib import Path
4+
35
from docutils.parsers.rst import directives
46

57
# -- Configuration to keep autosummary in sync with autoclass::members ----------------------------------------------
@@ -86,7 +88,7 @@
8688
#
8789
# This is also used if you do content translation via gettext catalogs.
8890
# Usually you set "language" from the command line for these cases.
89-
language = None
91+
language = "en"
9092

9193
# There are two options for replacing |today|: either, you set today to some
9294
# non-false value, then it is used:
@@ -385,8 +387,8 @@
385387
# Link to GitHub issues and pull requests using :pr:`1234` and :issue:`1234`
386388
# syntax
387389
extlinks = {
388-
"issue": ("https://github.com/dask/distributed/issues/%s", "GH#"),
389-
"pr": ("https://github.com/dask/distributed/pull/%s", "GH#"),
390+
"issue": ("https://github.com/dask/distributed/issues/%s", "GH#%s"),
391+
"pr": ("https://github.com/dask/distributed/pull/%s", "GH#%s"),
390392
}
391393

392394
# Configuration for intersphinx: refer to the Python standard library
@@ -432,9 +434,8 @@ def copy_legacy_redirects(app, docname):
432434
if app.builder.name == "html":
433435
for html_src_path, new in redirect_files:
434436
page = redirect_template.format(new=new)
435-
target_path = app.outdir + "/" + html_src_path
436-
with open(target_path, "w") as f:
437-
f.write(page)
437+
target_path = Path(app.outdir) / html_src_path
438+
target_path.write_text(page)
438439

439440

440441
class AutoAutoSummary(Autosummary):

docs/source/scheduling-policies.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ Adjusting or disabling queuing
268268
*adjusting this parameter.*
269269

270270
Queuing behavior is controlled by the ``distributed.scheduler.worker-saturation`` config
271-
value. This is set via the :doc:`Dask configuration system <configuration>`. The config
271+
value. This is set via the :external+dask:doc:`Dask configuration system <configuration>`. The config
272272
value must be set on the scheduler, before the scheduler starts.
273273

274274
The value controls how many initial chunks of data workers will have in memory at once.

docs/source/tls.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ One can also pass additional parameters:
5252

5353
All those parameters can be passed in several ways:
5454

55-
* through the Dask :doc:`configuration file <configuration>`;
55+
* through the Dask :external+dask:doc:`configuration file <configuration>`;
5656
* if using the command line, through options to ``dask scheduler`` and
5757
``dask worker``;
5858
* if using the API, through a ``Security`` object. For example, here is

0 commit comments

Comments
 (0)