configure the api documentation

.gitignore

@@ -70,6 +70,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/generated/
 
 # PyBuilder
 .pybuilder/

docs/api.rst

@@ -0,0 +1,40 @@
+.. _api:
+
+#############
+API reference
+#############
+
+Top-level functions
+===================
+
+.. currentmodule:: xdggs
+
+.. autosummary::
+   :toctree: generated/
+
+   decode
+
+
+.. currentmodule:: xarray
+
+Parameters
+==========
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary/accessor_attribute.rst
+
+   DataArray.dggs.grid_info
+   Dataset.dggs.grid_info
+
+
+Data inference
+==============
+
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary/accessor_method.rst
+
+   DataArray.dggs.cell_centers
+   DataArray.dggs.cell_boundaries
+   Dataset.dggs.cell_centers
+   Dataset.dggs.cell_boundaries

docs/conf.py

@@ -1,6 +1,10 @@
 # -- Project information -----------------------------------------------------
 import datetime as dt
 
+import sphinx_autosummary_accessors
+
+import xdggs  # noqa: F401
+
 project = "xdggs"
 author = f"{project} developers"
 initial_year = "2023"
@@ -18,9 +22,13 @@
 extensions = [
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
     "IPython.sphinxext.ipython_directive",
     "IPython.sphinxext.ipython_console_highlighting",
     "myst_parser",
+    "sphinx_autosummary_accessors",
 ]
 
 extlinks = {
@@ -29,7 +37,7 @@
 }
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
+templates_path = ["_templates", sphinx_autosummary_accessors.templates_path]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/index.md

@@ -1 +1,5 @@
 # welcome to the documentation of `xdggs`
+
+```{toctree}
+api.rst
+```