Merge e088d95 into 54c8527

raybellwaves · Aug 19, 2020 · 5a2e402 · 5a2e402
2 parents 54c8527 + e088d95
commit 5a2e402
Show file tree

Hide file tree

Showing 46 changed files with 452 additions and 430 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -14,7 +14,7 @@ Internal Changes
 Documentation
 -------------
 - Added ``sphinx`` documentation with full API and a quick start notebook.
-  (:pr:`127`) `Riley X. Brady`_.
+  (:pr:`127`) `Riley X. Brady`_ and `Ray Bell`_.
 
 Features
 --------

diff --git a/HOWTOCONTRIBUTE.rst b/HOWTOCONTRIBUTE.rst
@@ -81,7 +81,8 @@ documents. Some helpful guides are located
 
     .. code:: bash
 
-        $ conda env update -f ci/requirements-py36.yml
+        $ conda env update -f ci/doc.yml
+        $ conda activate xskillscore-docs
         $ cd docs
         $ make html
 

diff --git a/ci/doc.yml b/ci/doc.yml
@@ -5,10 +5,18 @@ dependencies:
   - python=3.6
   - bottleneck
   - importlib_metadata
+  - ipykernel
+  - ipython
   - nbsphinx
   - numpy
+  - pip
+  - properscoring
+  - scipy
   - sphinx
-  - sphinxcontrib-napoleon
   - sphinx_rtd_theme
+  - sphinx-autosummary-accessors
   - toolz
-  - xarray 
+  - xarray
+  - xhistogram
+  - pip:
+    - -e ..
diff --git a/ci/requirements-py36.yml b/ci/requirements-py36.yml
@@ -6,9 +6,9 @@ dependencies:
   # Documentation
   - nbsphinx
   - nbstripout
-  - sphinx_rtd_theme
   - sphinx
-  - sphinxcontrib-napoleon
+  - sphinx_rtd_theme
+  - sphinx-autosummary-accessors
   # IDE
   - jupyterlab
   # Numerics
@@ -17,6 +17,7 @@ dependencies:
   - dask
   - numba
   - numpy
+  - properscoring
   - scikit-learn
   - scipy
   - xarray
@@ -34,7 +35,3 @@ dependencies:
   - pytest-cov
   - pytest-lazy-fixture
   - pytest-sugar
-  - pip
-  - pip:
-      - properscoring
-      - pygments
diff --git a/docs/source/api/xskillscore.Contingency.accuracy.rst b/docs/source/api/xskillscore.Contingency.accuracy.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.accuracy
+xskillscore.Contingency.accuracy
 ================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.accuracy
+.. automethod:: Contingency.accuracy
diff --git a/docs/source/api/xskillscore.Contingency.bias_score.rst b/docs/source/api/xskillscore.Contingency.bias_score.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.bias\_score
+xskillscore.Contingency.bias\_score
 ===================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.bias_score
+.. automethod:: Contingency.bias_score
diff --git a/docs/source/api/xskillscore.Contingency.correct_negatives.rst b/docs/source/api/xskillscore.Contingency.correct_negatives.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.correct\_negatives
+xskillscore.Contingency.correct\_negatives
 ==========================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.correct_negatives
+.. automethod:: Contingency.correct_negatives
diff --git a/docs/source/api/xskillscore.Contingency.equit_threat_score.rst b/docs/source/api/xskillscore.Contingency.equit_threat_score.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.equit\_threat\_score
+xskillscore.Contingency.equit\_threat\_score
 ============================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.equit_threat_score
+.. automethod:: Contingency.equit_threat_score
diff --git a/docs/source/api/xskillscore.Contingency.false_alarm_rate.rst b/docs/source/api/xskillscore.Contingency.false_alarm_rate.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.false\_alarm\_rate
+xskillscore.Contingency.false\_alarm\_rate
 ==========================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.false_alarm_rate
+.. automethod:: Contingency.false_alarm_rate
diff --git a/docs/source/api/xskillscore.Contingency.false_alarm_ratio.rst b/docs/source/api/xskillscore.Contingency.false_alarm_ratio.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.false\_alarm\_ratio
+xskillscore.Contingency.false\_alarm\_ratio
 ===========================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.false_alarm_ratio
+.. automethod:: Contingency.false_alarm_ratio
diff --git a/docs/source/api/xskillscore.Contingency.false_alarms.rst b/docs/source/api/xskillscore.Contingency.false_alarms.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.false\_alarms
+xskillscore.Contingency.false\_alarms
 =====================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.false_alarms
+.. automethod:: Contingency.false_alarms
diff --git a/docs/source/api/xskillscore.Contingency.gerrity_score.rst b/docs/source/api/xskillscore.Contingency.gerrity_score.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.gerrity\_score
+xskillscore.Contingency.gerrity\_score
 ======================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.gerrity_score
+.. automethod:: Contingency.gerrity_score
diff --git a/docs/source/api/xskillscore.Contingency.heidke_score.rst b/docs/source/api/xskillscore.Contingency.heidke_score.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.heidke\_score
+xskillscore.Contingency.heidke\_score
 =====================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.heidke_score
+.. automethod:: Contingency.heidke_score
diff --git a/docs/source/api/xskillscore.Contingency.hit_rate.rst b/docs/source/api/xskillscore.Contingency.hit_rate.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.hit\_rate
+xskillscore.Contingency.hit\_rate
 =================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.hit_rate
+.. automethod:: Contingency.hit_rate
diff --git a/docs/source/api/xskillscore.Contingency.hits.rst b/docs/source/api/xskillscore.Contingency.hits.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.hits
+xskillscore.Contingency.hits
 ============================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.hits
+.. automethod:: Contingency.hits
diff --git a/docs/source/api/xskillscore.Contingency.misses.rst b/docs/source/api/xskillscore.Contingency.misses.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.misses
+xskillscore.Contingency.misses
 ==============================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.misses
+.. automethod:: Contingency.misses
diff --git a/docs/source/api/xskillscore.Contingency.odds_ratio.rst b/docs/source/api/xskillscore.Contingency.odds_ratio.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.odds\_ratio
+xskillscore.Contingency.odds\_ratio
 ===================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.odds_ratio
+.. automethod:: Contingency.odds_ratio
diff --git a/docs/source/api/xskillscore.Contingency.odds_ratio_skill_score.rst b/docs/source/api/xskillscore.Contingency.odds_ratio_skill_score.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.odds\_ratio\_skill\_score
+xskillscore.Contingency.odds\_ratio\_skill\_score
 =================================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.odds_ratio_skill_score
+.. automethod:: Contingency.odds_ratio_skill_score
diff --git a/docs/source/api/xskillscore.Contingency.peirce_score.rst b/docs/source/api/xskillscore.Contingency.peirce_score.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.peirce\_score
+xskillscore.Contingency.peirce\_score
 =====================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.peirce_score
+.. automethod:: Contingency.peirce_score
diff --git a/docs/source/api/xskillscore.Contingency.rst b/docs/source/api/xskillscore.Contingency.rst
@@ -1,18 +1,18 @@
-xskillscore.Contingency
+xskillscore.Contingency
 =======================
 
 .. currentmodule:: xskillscore
 
 .. autoclass:: Contingency
 
-
+   
    .. automethod:: __init__
 
-
+   
    .. rubric:: Methods
 
    .. autosummary::
-
+   
       ~Contingency.__init__
       ~Contingency.accuracy
       ~Contingency.bias_score
@@ -31,18 +31,20 @@ xskillscore.Contingency
       ~Contingency.peirce_score
       ~Contingency.success_ratio
       ~Contingency.threat_score
+
+
 
-
-
-
-
+
+
    .. rubric:: Attributes
 
    .. autosummary::
-
+   
       ~Contingency.dichotomous
       ~Contingency.forecast_category_edges
       ~Contingency.forecasts
       ~Contingency.observation_category_edges
       ~Contingency.observations
       ~Contingency.table
+
+
diff --git a/docs/source/api/xskillscore.Contingency.success_ratio.rst b/docs/source/api/xskillscore.Contingency.success_ratio.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.success\_ratio
+xskillscore.Contingency.success\_ratio
 ======================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.success_ratio
+.. automethod:: Contingency.success_ratio
diff --git a/docs/source/api/xskillscore.Contingency.threat_score.rst b/docs/source/api/xskillscore.Contingency.threat_score.rst
@@ -1,6 +1,6 @@
-xskillscore.Contingency.threat\_score
+xskillscore.Contingency.threat\_score
 =====================================
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.threat_score
+.. automethod:: Contingency.threat_score
diff --git a/docs/source/api/xskillscore.brier_score.rst b/docs/source/api/xskillscore.brier_score.rst
@@ -1,6 +1,6 @@
-xskillscore.brier\_score
+xskillscore.brier\_score
 ========================
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: brier_score
+.. autofunction:: brier_score
diff --git a/docs/source/api/xskillscore.crps_ensemble.rst b/docs/source/api/xskillscore.crps_ensemble.rst
@@ -1,6 +1,6 @@
-xskillscore.crps\_ensemble
+xskillscore.crps\_ensemble
 ==========================
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: crps_ensemble
+.. autofunction:: crps_ensemble
diff --git a/docs/source/api/xskillscore.crps_gaussian.rst b/docs/source/api/xskillscore.crps_gaussian.rst
@@ -1,6 +1,6 @@
-xskillscore.crps\_gaussian
+xskillscore.crps\_gaussian
 ==========================
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: crps_gaussian
+.. autofunction:: crps_gaussian
diff --git a/docs/source/api/xskillscore.crps_quadrature.rst b/docs/source/api/xskillscore.crps_quadrature.rst
@@ -1,6 +1,6 @@
-xskillscore.crps\_quadrature
+xskillscore.crps\_quadrature
 ============================
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: crps_quadrature
+.. autofunction:: crps_quadrature
diff --git a/docs/source/api/xskillscore.effective_sample_size.rst b/docs/source/api/xskillscore.effective_sample_size.rst
@@ -1,6 +1,6 @@
-xskillscore.effective\_sample\_size
+xskillscore.effective\_sample\_size
 ===================================
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: effective_sample_size
+.. autofunction:: effective_sample_size
diff --git a/docs/source/api/xskillscore.mae.rst b/docs/source/api/xskillscore.mae.rst
@@ -1,6 +1,6 @@
-xskillscore.mae
+xskillscore.mae
 ===============
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: mae
+.. autofunction:: mae
diff --git a/docs/source/api/xskillscore.mape.rst b/docs/source/api/xskillscore.mape.rst
@@ -1,6 +1,6 @@
-xskillscore.mape
+xskillscore.mape
 ================
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: mape
+.. autofunction:: mape
diff --git a/docs/source/api/xskillscore.median_absolute_error.rst b/docs/source/api/xskillscore.median_absolute_error.rst
@@ -1,6 +1,6 @@
-xskillscore.median\_absolute\_error
+xskillscore.median\_absolute\_error
 ===================================
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: median_absolute_error
+.. autofunction:: median_absolute_error
diff --git a/docs/source/api/xskillscore.mse.rst b/docs/source/api/xskillscore.mse.rst
@@ -1,6 +1,6 @@
-xskillscore.mse
+xskillscore.mse
 ===============
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: mse
+.. autofunction:: mse
diff --git a/docs/source/api/xskillscore.pearson_r.rst b/docs/source/api/xskillscore.pearson_r.rst
@@ -1,6 +1,6 @@
-xskillscore.pearson\_r
+xskillscore.pearson\_r
 ======================
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: pearson_r
+.. autofunction:: pearson_r
diff --git a/docs/source/api/xskillscore.pearson_r_eff_p_value.rst b/docs/source/api/xskillscore.pearson_r_eff_p_value.rst
@@ -1,6 +1,6 @@
-xskillscore.pearson\_r\_eff\_p\_value
+xskillscore.pearson\_r\_eff\_p\_value
 =====================================
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: pearson_r_eff_p_value
+.. autofunction:: pearson_r_eff_p_value