Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ tornado
toolz
cloudpickle
git+https://github.com/dask/dask
sphinx>=8,<9 # FIXME https://github.com/dask/distributed/issues/9189
sphinx>=8
dask-sphinx-theme>=4.0.0
sphinx-click
memray
Expand Down
17 changes: 14 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,28 @@
from __future__ import annotations

from inspect import signature
from pathlib import Path

from docutils.parsers.rst import directives

# -- Configuration to keep autosummary in sync with autoclass::members ----------------------------------------------
# Fixes issues/3693
# See https://stackoverflow.com/questions/20569011/python-sphinx-autosummary-automated-listing-of-member-functions
from sphinx.ext.autosummary import Autosummary, get_documenter
from sphinx.ext import autosummary as sphinx_autosummary
from sphinx.ext.autosummary import Autosummary
from sphinx.util.inspect import safe_getattr

import distributed


def get_documenter_objtype(app, obj, parent):
"""Return the Sphinx autodoc object type for an object."""
get_documenter = sphinx_autosummary._get_documenter
if "registry" in signature(get_documenter).parameters:
return get_documenter(obj, parent, registry=app.registry).objtype
return get_documenter(obj, parent)


#
# Dask.distributed documentation build configuration file, created by
# sphinx-quickstart on Tue Oct 6 14:42:44 2015.
Expand Down Expand Up @@ -458,10 +469,10 @@ def get_members(app, obj, typ, include_public=None):
items = []
for name in sorted(obj.__dict__.keys()):
try:
documenter = get_documenter(app, safe_getattr(obj, name), obj)
objtype = get_documenter_objtype(app, safe_getattr(obj, name), obj)
except AttributeError:
continue
if documenter.objtype in typ:
if objtype in typ:
items.append(name)
public = [x for x in items if x in include_public or not x.startswith("_")]
return public, items
Expand Down
Loading