Add user stories (#81)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: dcherian

ci/docs.yml

@@ -8,8 +8,12 @@ dependencies:
   - numpydoc
   - numpy_groupies
   - toolz
+  - matplotlib-base
   - myst-parser
+  - myst-nb
   - sphinx
   - furo
+  - ipykernel
+  - jupyter
   - pip:
     - git+https://github.com/dcherian/flox

docs/source/_static/style.css

@@ -0,0 +1,12 @@
+.xr-wrap {
+  font-size: 0.85em;
+  margin-left: 1.25em;
+  padding-left: 1.25em;
+  border-left: thin var(--color-foreground-muted) solid;
+}
+.xr-array-wrap, .xr-var-data, .xr-var-preview {
+  font-size: 0.9em;
+}
+.gp {
+  color: darkorange;
+}

docs/source/api.rst

@@ -40,5 +40,5 @@ Aggregation Objects
     :toctree: generated/
 
     aggregations.Aggregation
-    aggregations.sum
+    aggregations.sum_
     aggregations.nansum

docs/source/conf.py

@@ -16,6 +16,9 @@
 import sys
 
 import flox
+import flox.aggregations
+import flox.visualize
+import flox.xarray
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -29,14 +32,14 @@
 
 # -- General configuration -----------------------------------------------------
 extensions = [
-    "myst_parser",
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "sphinx.ext.extlinks",
     "numpydoc",
     "sphinx.ext.napoleon",
+    "myst_nb",
 ]
 
 extlinks = {
@@ -45,7 +48,7 @@
 }
 
 templates_path = ["_templates"]
-source_suffix = [".rst", ".md"]
+source_suffix = [".rst"]
 master_doc = "index"
 language = "en"
 
@@ -117,7 +120,8 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ["_static"]
+html_static_path = ["_static"]
+html_css_files = ["style.css"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

docs/source/index.md

@@ -50,4 +50,5 @@ It was motivated by many discussions in the [Pangeo](https://pangeo.io) communit
    implementation.md
    custom.md
    api.rst
+   user-stories.md
 ```

docs/source/user-stories.md

@@ -0,0 +1,8 @@
+# User Stories
+
+```{eval-rst}
+.. toctree::
+   :maxdepth: 1
+
+   user-stories/climatology.ipynb
+```