diff --git a/.gitignore b/.gitignore index 153ca39df0..5663f62d04 100644 --- a/.gitignore +++ b/.gitignore @@ -51,7 +51,7 @@ coverage.xml # Sphinx documentation docs/_build/ -docs/_autoapi +docs/api docs/data data data.zip diff --git a/docs/Makefile b/docs/Makefile index fc8fa12915..f42ee840e9 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -52,7 +52,7 @@ help: .PHONY: clean clean: rm -rf $(BUILDDIR)/* - rm -rf $(BUILDDIR)/../_autoapi + rm -rf $(BUILDDIR)/../api .PHONY: html html: diff --git a/docs/api/index.rst b/docs/api/index.rst deleted file mode 100644 index 26d7ce0224..0000000000 --- a/docs/api/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API reference -============= - -.. toctree:: - :maxdepth: 1 - - ../_autoapi/zarr/index diff --git a/docs/conf.py b/docs/conf.py index 3389c16549..2a93e61d3e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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', ] @@ -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 diff --git a/docs/index.rst b/docs/index.rst index 29baf4b94a..4cafc12711 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,7 @@ Zarr-Python quickstart user-guide/index - api/index + API reference developers/index developers/release about @@ -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