update docs for fitter module

phobson · Jan 2, 2016 · c12fdcc · c12fdcc
1 parent 2c1a3c1
commit c12fdcc
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 12 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = ../../paramnormal-docs
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,7 @@
 
 autodoc_member_order = 'bysource'
 
-import mock
+from unittest import mock
 
 MOCK_MODULES = ['scipy', 'scipy.stats']
 for mod_name in MOCK_MODULES:

diff --git a/docs/dist.rst b/docs/dist.rst
@@ -1,8 +1,8 @@
-.. _cont_auto:
+.. _dist_auto:
 
-Continuous Distributions
-========================
+Probability Distributions
+=========================
 
-.. automodule:: paramnormal.continuous
+.. automodule:: paramnormal.dist
    :members:
    :undoc-members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,17 +3,18 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to paramnormal's documentation!
-=======================================
+Welcome to paramnormal's
+========================
+
+.. include:: ../readme.rst
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-   continuous.rst
-   discrete.rst
-
+   dist.rst
+   fit.rst
 
 
 Indices and tables

diff --git a/paramnormal/fit.py b/paramnormal/fit.py
@@ -6,6 +6,12 @@
 from . import process_args
 
 
+__all__ = [
+    'normal',
+    'lognormal'
+]
+
+
 _docstring = """\
 
     Parameters
@@ -23,7 +29,7 @@
 
     See also
     --------
-    paramnormal.{}
+    paramnormal.dist.{}
 
 """