Merge pull request #28 from phobson/new-api-doc

New api doc

Author: phobson

.travis.yml

@@ -32,15 +32,15 @@ before_install:
   - ./miniconda.sh -b -p $HOME/miniconda
   - export PATH="$HOME/miniconda/bin:$PATH"
   - conda update --yes conda
+  - conda install --yes nomkl
 
 install:
 
   # We just set up a conda environment with the right Python version. This
   # should not need changing.
 
-  - conda create --yes -n test python=$TRAVIS_PYTHON_VERSION
+  - conda create --yes -n test python=$TRAVIS_PYTHON_VERSION numpy matplotlib docopt requests pyyaml
   - source activate test
-  - conda install --yes --channel=conda-forge numpy matplotlib docopt requests pyyaml
   - conda install --yes --channel=${TESTERS}
   - if [ ${COVERAGE} = true ]; then conda install scipy --yes; fi
   - pip install coveralls

docs/api/validate.rst

@@ -0,0 +1,11 @@
+.. _validate_auto:
+
+   The ``validate`` API
+
+``validate`` API Reference
+============================
+
+.. automodule:: probscale.validate
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/conf.py

@@ -17,6 +17,9 @@
 import os
 import shlex
 
+import seaborn
+clear_bkgd = {'axes.facecolor':'none', 'figure.facecolor':'none'}
+seaborn.set(style='ticks', context='talk', color_codes=True, rc=clear_bkgd)
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -60,6 +63,12 @@
 # source_suffix = ['.rst', '.md']
 source_suffix = '.rst'
 
+# Include the example source for plots in API docs
+plot_include_source = True
+plot_formats = [("png", 150)]
+plot_html_show_formats = False
+plot_html_show_source_link = False
+
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'
 

probscale/formatters.py

@@ -94,6 +94,17 @@ class PctFormatter(_FormatterMixin):
     """
     Formatter class for MPL axes to display probalities as percentages.
 
+    Examples
+    --------
+    >>> from probscale import formatters
+    >>> fmt = formatters.PctFormatter()
+    >>> fmt(0.2)
+    '0.2'
+    >>> fmt(10)
+    '10'
+    >>> fmt(99.999)
+    '99.999'
+
     """
 
     factor = 1.0
@@ -105,6 +116,19 @@ class ProbFormatter(_FormatterMixin):
     """
     Formatter class for MPL axes to display probalities as decimals.
 
+    Examples
+    --------
+    >>> from probscale import formatters
+    >>> fmt = formatters.ProbFormatter()
+    >>> fmt(0.01)
+    '0,01'
+    >>> fmt(0.2)
+    '0.20'
+    >>> try:
+    ...    fmt(10.5)
+    ... except(ValueError):
+    ...     print('formatter out of bounds')
+    formatter out of bounds
     """
 
     factor = 100.0

probscale/probscale.py

@@ -85,8 +85,8 @@ class ProbScale(ScaleBase):
         >>> from matplotlib import pyplot
         >>> import probscale
         >>> fig, ax = pyplot.subplots()
-        >>> ax.set_xlim(left=0.2, right=99.9)
-        >>> ax.set_xscale('prob')
+        >>> ax.set_ylim(bottom=0.2, top=99.9)
+        >>> ax.set_yscale('prob')
 
     """
 

probscale/tests/baseline_images/test_probscale/test_the_scale_default.png

@@ -6,7 +6,7 @@
 
 try:
     from scipy import stats
-except:
+except:  # pragma: no cover
     stats = None
 
 import pytest