Add documentation

docs/requirements.txt

@@ -5,4 +5,6 @@ pydata-sphinx-theme>=0.4.3
 setuptools>=50.3
 sphinx>=3.2
 jupyterlab>=3
+tqdm
+msgpack
 -r ../requirements.txt

docs/source/api.md

@@ -0,0 +1,26 @@
+# API Reference
+
+This is a reference API class listing, and modules.
+
+## Top-level functions
+
+```{eval-rst}
+.. currentmodule:: intake
+.. autosummary::
+   open_thredds_cat
+   open_thredds_merged
+
+```
+
+## Catalog & Source Objects
+
+```{eval-rst}
+.. currentmodule:: intake_thredds
+.. automodule:: intake_thredds.cat
+    :members:
+
+
+.. automodule:: intake_thredds.source
+    :members:
+
+```

docs/source/conf.py

@@ -44,7 +44,7 @@
     'IPython.sphinxext.ipython_console_highlighting',
     'IPython.sphinxext.ipython_directive',
     'sphinx.ext.napoleon',
-    'myst_parser',
+    'myst_nb',
 ]
 
 autodoc_member_order = 'groupwise'
@@ -68,16 +68,13 @@
 
 # Otherwise, the Return parameter list looks different from the Parameters list
 napoleon_use_rtype = False
+autodoc_typehints = 'none'
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
 
 
 # Enable notebook execution
-# https://nbsphinx.readthedocs.io/en/0.4.2/never-execute.html
-# nbsphinx_execute = 'auto'
-# Allow errors in all notebooks by
-nbsphinx_allow_errors = True
-
-# Disable cell timeout
-nbsphinx_timeout = -1
+jupyter_execute_notebooks = 'auto'
 
 
 # The suffix of source filenames.

docs/source/index.md

@@ -13,6 +13,8 @@ If you encounter any errors or problems with **intake-thredds**, please open an
 maxdepth: 2
 ---
 installation.md
+tutorial.ipynb
+api.md
 contributing.md
 changelog.md
 ```