Sweeping the docs.
This commit is contained in:
@ -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:
|
||||
|
||||
10
docs/reference/api_config.rst
Normal file
10
docs/reference/api_config.rst
Normal 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:
|
||||
@ -1,5 +1,5 @@
|
||||
Commands Reference
|
||||
==================
|
||||
Command-line Reference
|
||||
======================
|
||||
|
||||
Bonobo Init
|
||||
:::::::::::
|
||||
|
||||
@ -1,11 +1,10 @@
|
||||
References
|
||||
==========
|
||||
|
||||
.. todo:: write the fucking doc!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
commands
|
||||
api
|
||||
api_config
|
||||
commands
|
||||
examples
|
||||
|
||||
Reference in New Issue
Block a user