add references in docs to xhistogram and xrft (#20)

* add references in docs to xhistogram and xrft

* update changelog

* fix reference

Author: OriolAbril

README.md

@@ -319,6 +319,8 @@ Here we list some similar projects we know of. Note that all of
 them are complementary and don't overlap:
 * [xr-scipy](https://xr-scipy.readthedocs.io/en/latest/index.html)
 * [xarray-extras](https://xarray-extras.readthedocs.io/en/latest/)
+* [xhistogram](https://xhistogram.readthedocs.io/en/latest/)
+* [xrft](https://xrft.readthedocs.io/en/latest/)
 
 ## Cite xarray-einstats
 If you use this software, please cite it using the following template and the version

docs/source/changelog.md

@@ -5,7 +5,8 @@
 * Add `DaskBackend` to support using einops functions on Dask backed DataArrays {pull}`14`
 
 ### Documentation
-* Add dask support guide {pull}`14`
+* Add Dask support guide {pull}`14`
+* Add references to xhistogram and xrft in docs {pull}`20`
 
 ## v0.2.2 (2022 Apr 3)
 ### Maintenance and fixes

docs/source/conf.py

@@ -110,5 +110,6 @@
     "numpy": ("https://numpy.org/doc/stable/", None),
     "python": ("https://docs.python.org/3/", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
-    "xarray": ("http://docs.xarray.dev/en/stable/", None),
+    "xarray": ("https://docs.xarray.dev/en/stable/", None),
+    "xhistogram": ("https://xhistogram.readthedocs.io/en/latest", None),
 }

src/xarray_einstats/numba.py

@@ -91,6 +91,10 @@ def histogram(da, dims, bins=None, density=False, **kwargs):
     Note how the return is a single DataArray, not an array with the histogram and another
     with the bin edges. That is because the bin edges are included as coordinate values.
 
+    See Also
+    --------
+    xhistogram.xarray.histogram :
+        Alternative implementation (with some different features) of xarray aware histogram.
     """
     # TODO: make dask compatible even when bin edges are not passed manually
     if bins is None: