Add api using sphinx_autosummary_accessors (#43)

* Add api using sphinx_autosummary_accessors

* actual add api.rst

Author: dcherian

ci/doc.yml

@@ -15,3 +15,4 @@ dependencies:
   - pip:
       - cf_xarray
       - sphinx-book-theme
+      - git+https://github.com/keewis/sphinx-autosummary-accessors

doc/api.rst

@@ -0,0 +1,36 @@
+.. currentmodule:: xarray
+
+API
+===
+
+DataArray
+---------
+
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary/accessor_attribute.rst
+
+
+
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary/accessor_method.rst
+
+    DataArray.cf.describe
+    DataArray.cf.get_valid_keys
+
+Dataset
+-------
+
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary/accessor_attribute.rst
+
+
+
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary/accessor_method.rst
+
+    Dataset.cf.describe
+    Dataset.cf.get_valid_keys

doc/conf.py

@@ -15,6 +15,8 @@
 import os
 import sys
 
+import sphinx_autosummary_accessors
+
 import cf_xarray  # noqa
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -45,6 +47,7 @@
     "IPython.sphinxext.ipython_console_highlighting",
     "IPython.sphinxext.ipython_directive",
     "nbsphinx",
+    "sphinx_autosummary_accessors",
 ]
 
 extlinks = {
@@ -53,7 +56,7 @@
 }
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
+templates_path = ["_templates", sphinx_autosummary_accessors.templates_path]
 
 # The suffix of source filenames.
 source_suffix = ".rst"
@@ -294,3 +297,10 @@
     "python": ("https://docs.python.org/3/", None),
     "xarray": ("http://xarray.pydata.org/en/stable/", None),
 }
+
+autosummary_generate = True
+
+autodoc_typehints = "none"
+
+napoleon_use_param = True
+napoleon_use_rtype = True

doc/index.rst

@@ -15,6 +15,7 @@ on xarray objects.
    examples/index
    roadmap
    contributing
+   api
 
 Indices and tables
 ==================