From 6454c69bcac4450a6c334b84bc6c6baa5105765d Mon Sep 17 00:00:00 2001 From: David Stansby Date: Sun, 29 Sep 2024 22:50:19 +0100 Subject: [PATCH] Bump verison of autoapi used to build docs (#2177) * Bump verison of autoapi used to build docs * Fix autoapi build * Bump version of autoapi --------- Co-authored-by: Joe Hamman --- docs/conf.py | 13 +------------ pyproject.toml | 4 ++-- 2 files changed, 3 insertions(+), 14 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index c2805d623..2cb9ac016 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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"] @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 7e1688738..80f709c94 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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',