more documentage

This commit is contained in:
Romain Dorgueil
2017-05-01 10:21:56 +02:00
parent 71a32f623f
commit 8fc0430a23
6 changed files with 100 additions and 13 deletions

View File

@ -1,2 +1,2 @@
.node {
}
}

View File

@ -1,5 +1,5 @@
Command-line Reference
======================
Command-line
============
Bonobo Init
:::::::::::

View File

@ -1,13 +1,44 @@
Examples
========
There are a few examples bundled with **bonobo**. You'll find them under the :mod:`bonobo.examples` package.
There are a few examples bundled with **bonobo**. You'll find them under the :mod:`bonobo.examples` package, and
you can try them in a clone of bonobo by typing::
$ bonobo run bonobo/examples/.../file.py
Datasets
::::::::
.. module:: bonobo.examples.datasets
The :mod:`bonobo.examples.datasets` package contains examples that generates datasets locally for other examples to
use. As of today, we commit the content of those datasets to git, even if that may be a bad idea, so all the examples
are easily runnable. Later, we'll see if we favor a "missing dependency exception" approach.
Coffeeshops
-----------
.. automodule:: bonobo.examples.datasets.coffeeshops
:members:
:undoc-members:
:show-inheritance:
Fablabs
-------
.. automodule:: bonobo.examples.datasets.fablabs
:members:
:undoc-members:
:show-inheritance:
Types
:::::
bonobo.examples.types.strings
-----------------------------
Strings
-------
.. automodule:: bonobo.examples.types.strings
:members: graph, extract, transform, load
@ -15,8 +46,8 @@ bonobo.examples.types.strings
:show-inheritance:
bonobo.examples.types.dicts
---------------------------
Dicts
-----
.. automodule:: bonobo.examples.types.dicts
:members: graph, extract, transform, load
@ -24,8 +55,8 @@ bonobo.examples.types.dicts
:show-inheritance:
bonobo.examples.types.bags
--------------------------
Bags
----
.. automodule:: bonobo.examples.types.bags
:members: graph, extract, transform, load
@ -33,4 +64,15 @@ bonobo.examples.types.bags
:show-inheritance:
Utils
:::::
Count
-----
.. automodule:: bonobo.examples.utils.count
:members:
:undoc-members:
:show-inheritance: