[doc] Documentation work for the 0.4 release (not finished).
This commit is contained in:
@ -1,10 +1,16 @@
|
||||
Examples
|
||||
========
|
||||
|
||||
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::
|
||||
There are a few examples bundled with **bonobo**.
|
||||
|
||||
$ bonobo run bonobo/examples/.../file.py
|
||||
You'll find them under the :mod:`bonobo.examples` package, and you can run them directly as modules:
|
||||
|
||||
$ bonobo run -m bonobo.examples...module
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
examples/tutorials
|
||||
|
||||
|
||||
Datasets
|
||||
|
||||
50
docs/reference/examples/tutorials.rst
Normal file
50
docs/reference/examples/tutorials.rst
Normal file
@ -0,0 +1,50 @@
|
||||
Examples from the tutorial
|
||||
==========================
|
||||
|
||||
Examples from :doc:`/tutorial/tut01`
|
||||
::::::::::::::::::::::::::::::::::::
|
||||
|
||||
Example 1
|
||||
---------
|
||||
|
||||
.. automodule:: bonobo.examples.tutorials.tut01e01
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Example 2
|
||||
---------
|
||||
|
||||
.. automodule:: bonobo.examples.tutorials.tut01e02
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Examples from :doc:`/tutorial/tut02`
|
||||
::::::::::::::::::::::::::::::::::::
|
||||
|
||||
Example 1: Read
|
||||
---------------
|
||||
|
||||
.. automodule:: bonobo.examples.tutorials.tut02e01_read
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Example 2: Write
|
||||
----------------
|
||||
|
||||
.. automodule:: bonobo.examples.tutorials.tut02e02_write
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Example 3: Write as map
|
||||
-----------------------
|
||||
|
||||
.. automodule:: bonobo.examples.tutorials.tut02e02_writeasmap
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user