From aa7a0fff59f95c311c30a6e1b96e02b163389f30 Mon Sep 17 00:00:00 2001
From: Kristen Thyng <kristen@axds.co>
Date: Mon, 24 May 2021 16:23:03 -0500
Subject: [PATCH] fixed docs for sphinx

---
 docs/api.rst                   | 12 ++++++++++
 docs/index.rst                 |  2 +-
 extract_model/extract_model.py | 40 ++++++++++++++++++----------------
 3 files changed, 34 insertions(+), 20 deletions(-)
 create mode 100644 docs/api.rst

diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 0000000..e5d538b
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,12 @@
+:mod:`API`
+----------------------------
+
+`extract_model` Python API
+==========================
+
+
+.. automodule:: extract_model.extract_model
+   :members:
+   :inherited-members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
index f5a50ad..d3b8518 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,7 +12,7 @@ Use `extract_model` to read select output from model output files by time and/or
    :maxdepth: 2
 
    models
-
+   api
 
 
 Indices and tables
diff --git a/extract_model/extract_model.py b/extract_model/extract_model.py
index 7e53611..c437709 100644
--- a/extract_model/extract_model.py
+++ b/extract_model/extract_model.py
@@ -18,12 +18,15 @@
 def get_var_cf(ds, varname):
     """Match colloquial name to model name.
 
-    Inputs
-    ------
+    Parameters
+    ----------
     ds: Dataset
+        Dataset containing variable.
     varname: str
         Options: 'ssh', 'u', 'v', 'salt', 'temp'
 
+    Notes
+    -----
     The standard_names used for variables in model output are not the same.
     This function with the lists above connect colloquial names to the list of
     possible variable names above. Then, the name found in the dataset ds is
@@ -99,8 +102,8 @@ def select(
 ):
     """Extract output from ds at location(s).
 
-    Inputs
-    ------
+    Parameters
+    ----------
     ds: Dataset
         Property to take gradients of.
     longitude, latitude: int, float, list, array (1D or 2D), DataArray, optional
@@ -137,28 +140,27 @@ def select(
         or as `extra_value` if input.
     locstream: boolean, optional
         Which type of interpolation to do:
-        * False: 2D array of points with 1 dimension the lons and
-          the other dimension the lats.
-        * True: lons/lats as unstructured coordinate pairs
-          (in xESMF language, LocStream).
+
+        * False: 2D array of points with 1 dimension the lons and the other dimension the lats.
+        * True: lons/lats as unstructured coordinate pairs (in xESMF language, LocStream).
 
 
     Returns
     -------
     DataArray of interpolated and/or selected values from ds.
 
-    Example usage
-    -------------
+    Example
+    -------
+
     Select a single grid point.
-    ```
-    longitude = 100
-    latitude = 10
-    iZ = 0
-    iT = 0
-    varname = 'u'
-    kwargs = dict(ds=ds, longitude=longitude, latitude=latitude, iT=T, iz=Z, varname=varname)
-    dr = select(**kwargs)
-    ```
+
+    >>> longitude = 100
+    >>> latitude = 10
+    >>> iZ = 0
+    >>> iT = 0
+    >>> varname = 'u'
+    >>> kwargs = dict(ds=ds, longitude=longitude, latitude=latitude, iT=T, iz=Z, varname=varname)
+    >>> dr = select(**kwargs)
     """
 
     # can't run in both Z and iZ mode, same for T/iT