Merge pull request #3 from ContinuumIO/update-docs

Update docs

docs/environment.yml

@@ -0,0 +1,12 @@
+name: intake
+channels:
+  - intake
+  - defaults
+dependencies:
+  - python=3.6
+  - intake
+  - intake-netflow
+  - pip:
+    - sphinx
+    - sphinx-rtd-theme
+    - numpydoc

docs/source/api.rst

@@ -1,7 +1,22 @@
 API Reference
 =============
 
-.. autoclass:: intake_netflow.NetflowSource
-.. autoclass:: intake_netflow.Plugin
+.. currentmodule:: intake_netflow
+
+.. autosummary::
+   Plugin
+   intake_netflow.source.NetflowSource
+   intake_netflow.v9.PacketStream
+   intake_netflow.v9.RecordStream
+
+.. autoclass:: Plugin
+   :members:
+
+.. autoclass:: intake_netflow.source.NetflowSource
+   :members:
+
 .. autoclass:: intake_netflow.v9.PacketStream
+   :members:
+
 .. autoclass:: intake_netflow.v9.RecordStream
+   :members:

docs/source/conf.py

@@ -16,9 +16,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
 
 
 # -- General configuration ------------------------------------------------
@@ -30,7 +30,12 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc']
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosummary',
+    'numpydoc',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -82,7 +87,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