Merge pull request #22 from arokem/reference

DOC: Add the reference folder.
uwescience · Feb 11, 2016 · 36dcc06 · 36dcc06
2 parents f450cd2 + 222216f
commit 36dcc06
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 0 deletions.
diff --git a/doc/reference/index.rst b/doc/reference/index.rst
@@ -0,0 +1,8 @@
+.. AUTO-GENERATED FILE -- DO NOT EDIT!
+
+API Reference
+=============
+
+.. toctree::
+
+   shablona.rst
diff --git a/doc/reference/shablona.rst b/doc/reference/shablona.rst
@@ -0,0 +1,57 @@
+.. AUTO-GENERATED FILE -- DO NOT EDIT!
+
+:mod:`shablona`
+===============
+.. automodule:: shablona
+
+.. currentmodule:: shablona
+.. autosummary::
+
+   Fit
+   Model
+   cumgauss
+   opt_err_func
+   transform_data
+
+
+.. currentmodule:: shablona
+
+
+:class:`Fit`
+~~~~~~~~~~~~
+
+
+.. autoclass:: Fit
+  :members:
+  :undoc-members:
+  :show-inheritance:
+
+  .. automethod:: __init__
+
+
+:class:`Model`
+~~~~~~~~~~~~~~
+
+
+.. autoclass:: Model
+  :members:
+  :undoc-members:
+  :show-inheritance:
+
+  .. automethod:: __init__
+
+cumgauss
+~~~~~~~~
+
+.. autofunction:: cumgauss
+
+opt_err_func
+~~~~~~~~~~~~
+
+.. autofunction:: opt_err_func
+
+transform_data
+~~~~~~~~~~~~~~
+
+.. autofunction:: transform_data
+