Sweeping the docs.

This commit is contained in:
Romain Dorgueil
2017-05-01 09:56:10 +02:00
parent d79ca9e20e
commit 71a32f623f
10 changed files with 115 additions and 96 deletions

View File

@ -1,54 +1,13 @@
Public API
Bonobo API
==========
All the "public api" callables, classes and other callables are available under the root :mod:`bonobo` package, even if
they are documented within their sub-namespace, for convenience.
The Bonobo API, available directly under the :mod:`bonobo` package, contains all the tools you need to get started with
bonobo.
The :mod:`bonobo` package
:::::::::::::::::::::::::
.. automodule:: bonobo
:members: create_strategy, get_examples_path, run
:undoc-members:
:show-inheritance:
Config
------
.. automodule:: bonobo.config
:members:
:undoc-members:
:show-inheritance:
Context
-------
.. automodule:: bonobo.context
:members:
:undoc-members:
:show-inheritance:
Core
----
.. automodule:: bonobo.core
:members:
:undoc-members:
:show-inheritance:
IO
--
.. automodule:: bonobo.io
:members:
:undoc-members:
:show-inheritance:
Util
----
.. automodule:: bonobo.util
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,10 @@
Config API
==========
The Config API, located under the :mod:`bonobo.config` namespace, contains all the tools you need to create
configurable transformations, either class-based or function-based.
.. automodule:: bonobo.config
:members:
:undoc-members:
:show-inheritance:

View File

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

View File

@ -1,11 +1,10 @@
References
==========
.. todo:: write the fucking doc!
.. toctree::
:maxdepth: 4
commands
api
api_config
commands
examples