Major update to documentation, removing deprecated docs and adding the new syntax to graph building options.

docs/reference/api/bonobo.rst

@@ -5,6 +5,120 @@
 
 :Module: :mod:`bonobo`
 
+
 .. automodule:: bonobo
+   :no-members:
+
+
+
+Graphs
+::::::
+
+* :class:`bonobo.structs.graphs.Graph` 
+
+
+Nodes
+:::::
+
+* :class:`bonobo.nodes.CsvReader` 
+* :class:`bonobo.nodes.CsvWriter` 
+* :class:`bonobo.nodes.FileReader` 
+* :class:`bonobo.nodes.FileWriter` 
+* :class:`bonobo.nodes.Filter` 
+* :class:`bonobo.nodes.FixedWindow` 
+* :func:`bonobo.nodes.Format` 
+* :class:`bonobo.nodes.JsonReader` 
+* :class:`bonobo.nodes.JsonWriter` 
+* :class:`bonobo.nodes.LdjsonReader` 
+* :class:`bonobo.nodes.LdjsonWriter` 
+* :class:`bonobo.nodes.Limit` 
+* :func:`bonobo.nodes.MapFields` 
+* :func:`bonobo.nodes.OrderFields` 
+* :class:`bonobo.nodes.PickleReader` 
+* :class:`bonobo.nodes.PickleWriter` 
+* :class:`bonobo.nodes.PrettyPrinter` 
+* :class:`bonobo.nodes.RateLimited` 
+* :func:`bonobo.nodes.Rename` 
+* :func:`bonobo.nodes.SetFields` 
+* :func:`bonobo.nodes.Tee` 
+* :func:`bonobo.nodes.UnpackItems` 
+* :func:`bonobo.nodes.count` 
+* :func:`bonobo.nodes.identity` 
+* :func:`bonobo.nodes.noop` 
+
+
+Other top-level APIs
+::::::::::::::::::::
+
+* :func:`bonobo.create_reader` 
+* :func:`bonobo.create_strategy` 
+* :func:`bonobo.create_writer` 
+* :func:`bonobo.get_argument_parser` 
+* :func:`bonobo.get_examples_path` 
+* :func:`bonobo.inspect` 
+* :func:`bonobo.open_examples_fs` 
+* :func:`bonobo.open_fs` 
+* :func:`bonobo.parse_args` 
+* :func:`bonobo.run` 
+
+
+create_reader
+-------------
+
+.. autofunction:: bonobo.create_reader
+
+
+create_strategy
+---------------
+
+.. autofunction:: bonobo.create_strategy
+
+
+create_writer
+-------------
+
+.. autofunction:: bonobo.create_writer
+
+
+get_argument_parser
+-------------------
+
+.. autofunction:: bonobo.get_argument_parser
+
+
+get_examples_path
+-----------------
+
+.. autofunction:: bonobo.get_examples_path
+
+
+inspect
+-------
+
+.. autofunction:: bonobo.inspect
+
+
+open_examples_fs
+----------------
+
+.. autofunction:: bonobo.open_examples_fs
+
+
+open_fs
+-------
+
+.. autofunction:: bonobo.open_fs
+
+
+parse_args
+----------
+
+.. autofunction:: bonobo.parse_args
+
+
+run
+---
+
+.. autofunction:: bonobo.run
 
    

docs/reference/api/bonobo/config.rst

@@ -5,6 +5,9 @@
 
 :Module: :mod:`bonobo.config`
 
+
 .. automodule:: bonobo.config
 
+
+
    

docs/reference/api/bonobo/constants.rst

@@ -5,7 +5,10 @@
 
 :Module: :mod:`bonobo.constants`
 
+
 .. automodule:: bonobo.constants
    :no-members:
 
+
+
    

docs/reference/api/bonobo/execution.rst

@@ -5,15 +5,9 @@
 
 :Module: :mod:`bonobo.execution`
 
-.. toctree::
-    :caption: Submodules
-    :maxdepth: 1
-
-    execution/contexts
-    execution/events
-    execution/strategies
 
 .. automodule:: bonobo.execution
 
 
+
    

docs/reference/api/bonobo/execution/contexts.rst

@@ -5,6 +5,9 @@
 
 :Module: :mod:`bonobo.execution.contexts`
 
+
 .. automodule:: bonobo.execution.contexts
 
+
+
    

docs/reference/api/bonobo/execution/events.rst

@@ -5,6 +5,9 @@
 
 :Module: :mod:`bonobo.execution.events`
 
+
 .. automodule:: bonobo.execution.events
 
+
+
    

docs/reference/api/bonobo/execution/strategies.rst

@@ -5,6 +5,9 @@
 
 :Module: :mod:`bonobo.execution.strategies`
 
+
 .. automodule:: bonobo.execution.strategies
 
+
+
    

docs/reference/api/bonobo/nodes.rst

@@ -0,0 +1,13 @@
+:mod:`Nodes <bonobo.nodes>`
+===========================
+
+.. currentmodule:: bonobo.nodes
+
+:Module: :mod:`bonobo.nodes`
+
+
+.. automodule:: bonobo.nodes
+
+
+
+   

docs/reference/api/bonobo/structs/graphs.rst

@@ -0,0 +1,13 @@
+:mod:`Graphs <bonobo.structs.graphs>`
+=====================================
+
+.. currentmodule:: bonobo.structs.graphs
+
+:Module: :mod:`bonobo.structs.graphs`
+
+
+.. automodule:: bonobo.structs.graphs
+
+
+
+   

docs/reference/api/bonobo/util.rst

@@ -5,6 +5,9 @@
 
 :Module: :mod:`bonobo.util`
 
+
 .. automodule:: bonobo.util
 
+
+
    

docs/reference/examples.rst

@@ -18,7 +18,6 @@ or
 
 
 
-
 .. toctree::
     :maxdepth: 4
 

docs/reference/index.rst

@@ -11,8 +11,9 @@ means that the api is not yet 1.0-proof.
     api/bonobo/config
     api/bonobo/constants
     api/bonobo/execution
+    api/bonobo/nodes
+    api/bonobo/structs/graphs
     api/bonobo/util
     commands
     settings
     examples
-    private