From 3c8c76ce87094df398769b28c3fa594267106522 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Wed, 11 Sep 2024 23:19:20 +0100 Subject: [PATCH 1/3] Bump verison of autoapi used to build docs --- pyproject.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 49878b61f6..f41d8fd2fe 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.1.0', 'sphinx_design', 'sphinx-issues', 'sphinx-copybutton', From 217b5dc7e71fcf76cc9242349604b61b7bdd00f3 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Thu, 12 Sep 2024 00:16:52 +0100 Subject: [PATCH 2/3] Fix autoapi build --- docs/conf.py | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index c2805d6239..2cb9ac0161 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 From 9b0480d38b91ba69fdd73502b48d2ef6e323bc8e Mon Sep 17 00:00:00 2001 From: David Stansby Date: Thu, 12 Sep 2024 00:17:32 +0100 Subject: [PATCH 3/3] Bump version of autoapi --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index f41d8fd2fe..874ef2d05a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -80,7 +80,7 @@ gpu = [ docs = [ 'sphinx==7.4.7', 'sphinx-autobuild>=2021.3.14', - 'sphinx-autoapi==3.1.0', + 'sphinx-autoapi==3.3.1', 'sphinx_design', 'sphinx-issues', 'sphinx-copybutton',