Skip to content
Merged
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
13 changes: 1 addition & 12 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
autoapi_member_order = "groupwise"
autoapi_root = "_autoapi"
autoapi_keep_files = True

autoapi_options = [ 'members', 'undoc-members', 'show-inheritance', 'show-module-summary', 'imported-members', ]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down Expand Up @@ -173,19 +173,8 @@
html_logo = "_static/logo1.png"


def autoapi_skip_modules(app: sphinx.application.Sphinx, what: str, name: str, obj: object, skip: bool, options: dict[str, Any]) -> bool:
"""
Return True if a module should be skipped in th API docs.
"""
parts = name.split(".")
if what == "module" and (any(part.startswith("_") for part in parts) or "v2" in name or name.startswith("zarr.core")):
return True
return False


def setup(app: sphinx.application.Sphinx) -> None:
app.add_css_file("custom.css")
app.connect("autoapi-skip-member", autoapi_skip_modules)


# The name of an image file (relative to this directory) to use as a favicon of
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ gpu = [
"cupy-cuda12x",
]
docs = [
'sphinx<8',
'sphinx==7.4.7',
'sphinx-autobuild>=2021.3.14',
'sphinx-autoapi<3.1',
'sphinx-autoapi==3.3.1',
'sphinx_design',
'sphinx-issues',
'sphinx-copybutton',
Expand Down