update changelog, various docs pages

CHANGELOG.rst

@@ -7,11 +7,16 @@ xskillscore v0.0.17 (2020-08-xx)
 
 Breaking Changes
 ----------------
-- Rename `dim` to `member_dim` in probabilistic metrics. (:pr:121) `Aaron Spring`_
+- Rename ``dim`` to ``member_dim`` in probabilistic metrics. (:pr:`121`) `Aaron Spring`_
+
+Documentation
+-------------
+- Added ``sphinx`` documentation with full API and a quick start notebook.
+  (:pr:`127`) `Riley X. Brady`_.
 
 Features
 --------
-- Add `dim` and `weights` for probabilistic metrics. (:pr:121) `Aaron Spring`_
+- Add ``dim`` and ``weights`` for probabilistic metrics. (:pr:`121`) `Aaron Spring`_
 
 
 xskillscore v0.0.16 (2020-07-18)

HOWTOCONTRIBUTE.rst

@@ -65,11 +65,30 @@ Talk to developers to find out how you can fix specific bugs.
 Write documentation
 -------------------
 
-``xskillscore`` could always use more documentation. We have an open issue to build the documentation on a website: https://github.com/raybellwaves/xskillscore/issues/36
+``xskillscore`` could always use more documentation. What could you add?
 
+* More complementary documentation. Have you perhaps found something unclear?
+* Docstrings.
+* Example notebooks of ``xskillscore`` being used in real analyses.
 
- .. _`pull requests`:
- .. _pull-requests:
+Our documentation is written in reStructuredText. You can follow our conventions in already written
+documents. Some helpful guides are located
+`here <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`__ and
+`here <https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst>`__.
+
+.. note::
+    Build the documentation locally with the following command:
+
+    .. code:: bash
+
+        $ conda env update -f ci/requirements-py36.yml
+        $ cd docs
+        $ make html
+
+    The build documentation should be available in the ``docs/build/`` folder.
+
+If you are adding new functions to the API, run ``sphinx-autogen -o api api.rst`` from the
+``docs/source`` directory and add the functions to ``api.rst``.
 
 Preparing Pull Requests
 -----------------------
@@ -176,6 +195,8 @@ defined in ``deterministic.py``.
    - Add yourself to list of authors at the end of ``CHANGELOG.rst`` file if not there yet, in
      alphabetical order.
 
+#. Add yourself to the contributors list via ``docs/source/contributors.rst``.
+
 
 #. Finally, submit a pull request through the GitHub website using this data::
 

HOWTORELEASE.rst

@@ -31,18 +31,21 @@ a minor version adds functionality, and a patch covers bug fixes.
     $ git push -f origin stable
     $ git checkout master
 
-#. Update esmtools conda-forge feedstock
+#. Go to https://readthedocs.org and add the new version to "Active Versions"
+   under the version tab. Force-build "stable" if it isn't already building.
 
- * Fork `esmtools-feedstock repository <https://github.com/conda-forge/esmtools-feedstock>`_
+#. Update ``xskillscore`` conda-forge feedstock
+
+ * Fork `xskillscore-feedstock repository <https://github.com/conda-forge/xskillscore-feedstock>`_
  * Clone this fork and edit recipe::
 
-        $ git clone git@github.com:username/esmtools-feedstock.git
-        $ cd esmtools-feedstock
+        $ git clone git@github.com:username/xskillscore-feedstock.git
+        $ cd xskillscore-feedstock
         $ cd recipe
         $ # edit meta.yaml
 
  - Update version
- - Get sha256 from pypi.org for `esmtools <https://pypi.org/project/esmtools/#files>`_
- - Fill in the rest of information as described `here <https://github.com/conda-forge/esmtools-feedstock#updating-esmtools-feedstock>`_
+ - Get sha256 from pypi.org for `esmtools <https://pypi.org/project/xskillscore/#files>`_
+ - Fill in the rest of information as described `here <https://github.com/conda-forge/xskillscore-feedstock#updating-esmtools-feedstock>`_
 
  * Commit and submit a PR

docs/source/api.rst

@@ -45,6 +45,10 @@ Probabilistic Metrics
 
 .. currentmodule:: xskillscore.core.probabilistic
 
+Currently, our probabilistic metrics are ported over from
+`properscoring <https://github.com/TheClimateCorporation/properscoring>`__ to work with
+``xarray`` DataArrays and Datasets.
+
 .. autosummary::
     :toctree: api/
 

docs/source/contributors.rst

@@ -4,10 +4,14 @@ Contributors
 
 Core Developers
 ===============
+* Ray Bell (`github <https://github.com/raybellwaves/>`__
 * Riley X. Brady (`github <https://github.com/bradyrx/>`__)
+* Aaron Spring (`github <https://github.com/aaronspring/>`__)
 
 Contributors
 ============
-* Aaron Spring (`github <https://github.com/aaronspring/>`__)
+* Andrew Huang (`github <https://github.com/ahuang11/>`__)
+* Dougie Squire (`github <https://github.com/dougiesquire/>`__)
 
-For a list of all the contributions, see the github `contribution graph <https://github.com/bradyrx/esmtools/graphs/contributors>`__.
+For a list of all the contributions, see the github
+`contribution graph <https://github.com/raybellwaves/xskillscore/graphs/contributors>`__.