Skip to content

Commit 6454c69

Browse files
dstansbyjhamman
andauthored
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 <[email protected]>
1 parent 73b884b commit 6454c69

File tree

2 files changed

+3
-14
lines changed

2 files changed

+3
-14
lines changed

docs/conf.py

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
autoapi_member_order = "groupwise"
6262
autoapi_root = "_autoapi"
6363
autoapi_keep_files = True
64-
64+
autoapi_options = [ 'members', 'undoc-members', 'show-inheritance', 'show-module-summary', 'imported-members', ]
6565

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

175175

176-
def autoapi_skip_modules(app: sphinx.application.Sphinx, what: str, name: str, obj: object, skip: bool, options: dict[str, Any]) -> bool:
177-
"""
178-
Return True if a module should be skipped in th API docs.
179-
"""
180-
parts = name.split(".")
181-
if what == "module" and (any(part.startswith("_") for part in parts) or "v2" in name or name.startswith("zarr.core")):
182-
return True
183-
return False
184-
185-
186176
def setup(app: sphinx.application.Sphinx) -> None:
187177
app.add_css_file("custom.css")
188-
app.connect("autoapi-skip-member", autoapi_skip_modules)
189178

190179

191180
# The name of an image file (relative to this directory) to use as a favicon of

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ gpu = [
7878
"cupy-cuda12x",
7979
]
8080
docs = [
81-
'sphinx<8',
81+
'sphinx==7.4.7',
8282
'sphinx-autobuild>=2021.3.14',
83-
'sphinx-autoapi<3.1',
83+
'sphinx-autoapi==3.3.1',
8484
'sphinx_design',
8585
'sphinx-issues',
8686
'sphinx-copybutton',

0 commit comments

Comments
 (0)