list API in alphabetical order

CHANGELOG.rst

@@ -5,6 +5,10 @@ Changelog History
 xskillscore v0.0.21 (2021-XX-XX)
 --------------------------------
 
+Documentation
+~~~~~~~~~~~~~
+- Added more info in ``quick-start.ipynb`` (:pr:`316`) `Ray Bell`_.
+
 
 xskillscore v0.0.20 (2021-05-08)
 --------------------------------

ci/docs_notebooks.yml

@@ -23,6 +23,11 @@ dependencies:
   - sphinx
   - sphinxcontrib-napoleon
   - sphinx_rtd_theme
+  - black
+  - doc8
+  - isort
+  - flake8
+  - pre-commit
   - pip
   - pip:
       - sphinx_autosummary_accessors

docs/source/api.rst

@@ -16,29 +16,30 @@ Correlation Metrics
 .. autosummary::
     :toctree: api/
 
+    effective_sample_size
     pearson_r
     pearson_r_p_value
     pearson_r_eff_p_value
+    linslope
     spearman_r
     spearman_r_p_value
     spearman_r_eff_p_value
-    effective_sample_size
-    r2
-    linslope
+
 
 Distance Metrics
 ~~~~~~~~~~~~~~~~
 
 .. autosummary::
     :toctree: api/
 
-    me
-    rmse
-    mse
     mae
+    mape
+    me
     median_absolute_error
+    mse
+    r2
+    rmse
     smape
-    mape
 
 
 Probabilistic Metrics
@@ -55,12 +56,13 @@ Currently, most of our probabilistic metrics are ported over from
     crps_ensemble
     crps_gaussian
     crps_quadrature
-    threshold_brier_score
-    rps
-    rank_histogram
     discrimination
+    rank_histogram
     reliability
     roc
+    rps
+    threshold_brier_score
+
 
 Contingency-based Metrics
 -------------------------
@@ -87,19 +89,20 @@ Dichotomous-Only (yes/no) Metrics
 .. autosummary::
     :toctree: api/
 
-    Contingency.hits
-    Contingency.misses
-    Contingency.false_alarms
-    Contingency.correct_negatives
     Contingency.bias_score
-    Contingency.hit_rate
-    Contingency.false_alarm_ratio
-    Contingency.false_alarm_rate
-    Contingency.success_ratio
-    Contingency.threat_score
+    Contingency.correct_negatives
     Contingency.equit_threat_score
+    Contingency.false_alarm_rate
+    Contingency.false_alarm_ratio
+    Contingency.false_alarms
+    Contingency.hit_rate
+    Contingency.hits
+    Contingency.misses
     Contingency.odds_ratio
     Contingency.odds_ratio_skill_score
+    Contingency.success_ratio
+    Contingency.threat_score
+
 
 Multi-Category Metrics
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -108,11 +111,12 @@ Multi-Category Metrics
     :toctree: api/
 
     Contingency.accuracy
+    Contingency.gerrity_score
     Contingency.heidke_score
     Contingency.peirce_score
-    Contingency.gerrity_score
     roc
 
+
 Comparative
 -----------
 
@@ -121,8 +125,9 @@ Tests to compare whether one forecast is significantly better than another one.
 .. autosummary::
     :toctree: api/
 
-    sign_test
     mae_test
+    sign_test
+
 
 Resampling
 ----------

docs/source/index.rst

@@ -39,7 +39,7 @@ You can also install the bleeding edge (pre-release versions) by running:
 
 .. code-block:: bash
 
-    pip install git+https://github.com/xarray-contrib/xskillscore@master --upgrade
+    pip install git+https://github.com/xarray-contrib/xskillscore@main --upgrade
 
 **Getting Started**