Merge pull request #16 from SylvainCorlay/api_reference

Add API reference documentation
jupyter-widgets · Sep 23, 2016 · b3b8225 · b3b8225
2 parents f38a372 + 970bf49
commit b3b8225
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -52,6 +52,7 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
+docs/source/_generate/
 
 # PyBuilder
 target/

diff --git a/docs/source/api_documentation.rst b/docs/source/api_documentation.rst
@@ -1,4 +1,22 @@
 API Reference Documentation
 ---------------------------
 
-.. automodule:: traittypes
+The ``SciType`` trait type is the base trait type for all Scipy trait types.
+
+It complements the ``traitlets.TraitType`` with a special API to register custom
+validators.
+
+.. autoclass:: traittypes.traittypes.SciType
+   :members:
+
+The ``Array`` trait type holds a numpy Array.
+
+.. autoclass:: traittypes.traittypes.Array
+
+The ``DataFrame`` trait type holds a pandas DataFrame.
+
+.. autoclass:: traittypes.traittypes.DataFrame
+
+The ``Series`` trait type holds a pandas Series.
+
+.. autoclass:: traittypes.traittypes.Series
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,6 +6,4 @@ traittypes: Trait Types for Scientific Python
 
    introduction
    usage
-
-..
    api_documentation
diff --git a/traittypes/traittypes.py b/traittypes/traittypes.py
@@ -5,7 +5,7 @@
 
 class SciType(TraitType):
 
-    """A base traittype for numpy arrays, pandas dataframes and series."""
+    """A base trait type for numpy arrays, pandas dataframes and series."""
 
     def valid(self, *validators):
         """
@@ -24,7 +24,8 @@ def valid(self, *validators):
         Example
         -------
 
-        .. code-block:: python
+        .. code:: python
+
             # Test with a shape constraint
             def shape(*dimensions):
                 def validator(trait, value):