Doc Cleanup (#977)

* start refactoring api reference

* update order of user guide

* work on api reference

* update reference api

* fix typo

* start refactoring README

* fix typo

* update api ref

* add plotting methods to api

* update plotting docstrings

* o Fix spelling and try to fix the usage code-block

* o update example

* update docstrings

* update backend parameter

* update private API blurb

* o Try Usage to Examples which is more standard in docstrings for example usage.

* one more usage to example

* remove private api blurb

* update plotting user guide notebook

* update remapping docstrings

* cleanup more docstrings

* clean up object docstrings

* cleanup plotting docstrings

* update name of gca_const_lat_intersection

* update data array conersion methods

* update README

* fix gradient example

* o Add backend to doc

* update README

* add units for descriptors

---------

Co-authored-by: Rajeev Jain <[email protected]>

README.md

@@ -42,34 +42,42 @@ commonly-used for structured grids recognition, to support reading and
 recognizing unstructured grid model outputs. We picked the name "UXarray"
 (pronounced "you-ex-array"), with the "U" representing unstructured grids.
 
-## UXarray Functionality
-
-The following intended functionality has been inspired by discussions with
+## Features
+
+* ``Grid`` class for storing grid information and providing grid-specific functionality
+  * Support for reading UGRID, MPAS, ESMF, ICON, GEOS-CS, SCRIP, and EXODUS grid formats
+* Extension of xarray's ``DataArray`` and ``Dataset`` classe to support unstructured grid operations
+  * ``uxarray.UxDataArray`` inherits ``xarray.DataArray`` and is attached to a ``Grid`` instance through the ``.uxgrid`` accessor
+  * ``uxarray.UxDataset`` inherits ``xarray.Dataset`` and is attached to a ``Grid`` instance through the ``.uxgrid`` accessor
+* Extension of xarray's ``open_dataset`` and ``open_mfdataset`` methods to support reading grid and data files
+* Plotting
+  * Native visualization of unstructured grids written using the ``hvPlot`` package
+  * Support for grid topology visualization (i.e. exploring the geometry of a grid) and data visualization (i.e. data mapped to each face)
+* Subsetting
+  * Ability to select arbitrary regions of a grid using different selection methods (nearest neighbor, bounding circle, bounding box)
+* Remapping
+  * Support for nearest neighbor and inverse distance weighted unstructured to unstructured remapping
+* Topological Aggregations
+  * Perform aggregations within different topology elements using connectivity information
+* Mathematical Operators
+  * Support for Integral, Difference, and Gradient calculations
+
+
+## Intended Features
+
+The following intended features have been inspired by discussions with
 members of the scientific community, within the SEATS Project and Project
 Raijin, and on several community platforms such as [Xarray GitHub
 Repository](https://github.com/pydata/xarray/issues/4222). The UXarray team
 is receptive to additional functionality requests.
 
-## Intended Functionality for Grids
 
-* Support for reading and writing UGRID, SCRIP ESMF, and Exodus formatted grids.
-* Support for reading and writing shapefiles.
 * Support for arbitrary structured and unstructured grids on the sphere,
   including latitude-longitude grids, grids with only partial coverage of
   the sphere, and grids with concave faces.
 * Support for finite volume and finite element outputs.
-* Support for edges that are either great circle arcs or lines of constant
-  latitude.
-* Calculation of face areas, centroids, and bounding latitude-longitude boxes.
 * Triangular decompositions.
 * Calculation of supermeshes (consisting of grid lines from two input grids).
-
-## Intended Functionality for DataArrays on Grids
-
-* Regridding of data between unstructured grids.
-* Global and regional integration of fields, including zonal averages.
-* Application of calculus operations, including divergence, curl, Laplacian
-  and gradient.
 * Snapshots and composites following particular features.
 
 ## Documentation

ci/docs.yml

@@ -20,6 +20,7 @@ dependencies:
     - scikit-learn
     - sphinx-book-theme
     - sphinx-autosummary-accessors
+    - sphinx-remove-toctrees
     - myst-nb
     - sphinx-design
     - nbsphinx