cleaned up/organized docs

Author: phobson

README.md

@@ -0,0 +1,28 @@
+mpl-probscale: Real probability scales for matplotlib
+=====================================================
+
+.. image:: https://travis-ci.org/phobson/watershed.svg?branch=master
+    :target: https://travis-ci.org/phobson/watershed
+
+.. image:: https://coveralls.io/repos/phobson/mpl-probscale/badge.svg?branch=master&service=github
+  :target: https://coveralls.io/github/phobson/mpl-probscale?branch=master
+
+
+Simply importing ``probscale`` let's you use probability scales in your matplotlib figures:
+
+.. code-block:: python
+
+    import matplotlib.pyplot as plt
+    import probscale
+
+    plt.style.use('ggplot')
+    fig, ax = plt.subplots(figsize=(8, 4))
+    ax.set_ylim(1e-2, 1e2)
+    ax.set_yscale('log')
+
+    ax.set_xlim(0.5, 99.5)
+    ax.set_xscale('prob')
+
+
+.. image:: /img/example.png
+

README.rst

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = ../../mpl-probscale-docs
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

docs/Makefile

@@ -17,11 +17,6 @@
 import os
 import shlex
 
-import mock
- 
-MOCK_MODULES = ['numpy', 'scipy', 'matplotlib', 'matplotlib.pyplot', 'scipy.stats']
-for mod_name in MOCK_MODULES:
-    sys.modules[mod_name] = mock.Mock()
 
 # 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
@@ -33,7 +28,13 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-source_suffix = ['.rst']
+from recommonmark.parser import CommonMarkParser
+
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
+source_suffix = ['.rst', '.md']
 
 numpydoc_show_class_members = False
 autodoc_member_order = 'bysource'
@@ -129,7 +130,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/conf.py

@@ -3,10 +3,13 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to probscale's documentation!
-=====================================
 
-Contents:
+.. include:: ../README.rst
+
+
+
+API References
+==============
 
 .. toctree::
    :maxdepth: 2
@@ -16,7 +19,6 @@ Contents:
    probscale.rst
 
 
-
 Indices and tables
 ==================
 

docs/index.rst

@@ -5,7 +5,7 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set BUILDDIR=_build
+set BUILDDIR=../../mpl-probscale-docs
 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
 set I18NSPHINXOPTS=%SPHINXOPTS% .
 if NOT "%PAPER%" == "" (