Skip to content

Improve API reference doc structure #2635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 6, 2025
Merged

Improve API reference doc structure #2635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6866af
Improve API reference doc structure
dstansby Jan 3, 2025
877f521
Merge branch 'main' into api-doc-struct
jhamman Jan 6, 2025
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 .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ coverage.xml

# Sphinx documentation
docs/_build/
docs/_autoapi
docs/api
docs/data
data
data.zip
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ help:
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
rm -rf $(BUILDDIR)/../_autoapi
rm -rf $(BUILDDIR)/../api

.PHONY: html
html:
Expand Down
7 changes: 0 additions & 7 deletions docs/api/index.rst
View file
Open in desktop

This file was deleted.

3 changes: 2 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
autoapi_add_toctree_entry = False
autoapi_generate_api_docs = True
autoapi_member_order = "groupwise"
autoapi_root = "_autoapi"
autoapi_root = "api"
autoapi_keep_files = True
autoapi_options = [ 'members', 'undoc-members', 'show-inheritance', 'show-module-summary', 'imported-members', ]

Expand Down Expand Up @@ -108,6 +108,7 @@ def skip_submodules(
"release": "developers/release.html",
"roadmap": "developers/roadmap.html",
"installation": "user-guide/installation.html",
"api": "api/zarr/index"
}

# The language for content autogenerated by Sphinx. Refer to documentation
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Zarr-Python

quickstart
user-guide/index
api/index
API reference <api/zarr/index>
developers/index
developers/release
about
Expand Down Expand Up @@ -81,12 +81,12 @@ Zarr-Python is a Python library for reading and writing Zarr groups and arrays.

+++

.. button-ref:: api/index
.. button-ref:: api/zarr/index
:expand:
:color: dark
:click-parent:

To the API reference guide
To the API reference

.. grid-item-card::
:img-top: _static/index_contribute.svg
Expand Down
Loading