Completed incorporation of the interfaces documentation

WIP #237
spacetelescope · Dec 29, 2016 · d7db979 · d7db979
1 parent 33f7191
commit d7db979
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -51,7 +51,21 @@ Interfaces
 .. automodapi:: specviz.interfaces
    :no-heading:
 
+Model Factories
+^^^^^^^^^^^^^^^
+.. automodapi:: specviz.interfaces.factories
+   :no-heading:
+   :no-main-docstr:
+   :headings:""
+
+Model Initialization
+^^^^^^^^^^^^^^^^^^^^
+.. automodapi:: specviz.interfaces.initializers
+   :no-heading:
+   :no-main-docstr:
+   :headings:""
 
+
 I/O module
 ----------
 .. automodapi:: specviz.io

diff --git a/specviz/interfaces/factories.py b/specviz/interfaces/factories.py
@@ -14,6 +14,11 @@
 # THIRD-PARTY
 from astropy.modeling import models, fitting
 
+__all__ = [
+    'Factory',
+    'FitterFactory',
+    'ModelFactory',
+]
 
 class Factory(object):
     """

diff --git a/specviz/interfaces/initializers.py b/specviz/interfaces/initializers.py
@@ -11,6 +11,10 @@
 
 from ..analysis.models import spline, blackbody
 
+__all__ = [
+    'initialize'
+]
+
 AMPLITUDE = 'amplitude'
 POSITION  = 'position'
 WIDTH     = 'width'
@@ -236,7 +240,9 @@ def _setattr(instance, mname, pname, value):
 
 def initialize(instance, x, y):
     """
-    Main entry point. X and Y are for now Quantity arrays with the
+    Initialize given model.
+
+    X and Y are for now Quantity arrays with the
     independent and dependent variables. It's assumed X values
     are stored in increasing order in the array.