Major update to documentation, removing deprecated docs and adding the new syntax to graph building options.
This commit is contained in:
@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user