[doc] proofreading the guides, refactoring the reference.
This commit is contained in:
@ -1,12 +0,0 @@
|
||||
Bonobo API
|
||||
==========
|
||||
|
||||
The Bonobo API, available directly under the :mod:`bonobo` package, contains all the tools you need to get started with
|
||||
bonobo.
|
||||
|
||||
.. automodule:: bonobo
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
10
docs/reference/api/bonobo.rst
Normal file
10
docs/reference/api/bonobo.rst
Normal file
@ -0,0 +1,10 @@
|
||||
:mod:`Bonobo <bonobo>`
|
||||
======================
|
||||
|
||||
.. currentmodule:: bonobo
|
||||
|
||||
:Module: :mod:`bonobo`
|
||||
|
||||
.. automodule:: bonobo
|
||||
|
||||
|
||||
10
docs/reference/api/bonobo/config.rst
Normal file
10
docs/reference/api/bonobo/config.rst
Normal file
@ -0,0 +1,10 @@
|
||||
:mod:`Config <bonobo.config>`
|
||||
=============================
|
||||
|
||||
.. currentmodule:: bonobo.config
|
||||
|
||||
:Module: :mod:`bonobo.config`
|
||||
|
||||
.. automodule:: bonobo.config
|
||||
|
||||
|
||||
11
docs/reference/api/bonobo/constants.rst
Normal file
11
docs/reference/api/bonobo/constants.rst
Normal file
@ -0,0 +1,11 @@
|
||||
:mod:`Constants <bonobo.constants>`
|
||||
===================================
|
||||
|
||||
.. currentmodule:: bonobo.constants
|
||||
|
||||
:Module: :mod:`bonobo.constants`
|
||||
|
||||
.. automodule:: bonobo.constants
|
||||
:no-members:
|
||||
|
||||
|
||||
19
docs/reference/api/bonobo/execution.rst
Normal file
19
docs/reference/api/bonobo/execution.rst
Normal file
@ -0,0 +1,19 @@
|
||||
:mod:`Execution <bonobo.execution>`
|
||||
===================================
|
||||
|
||||
.. currentmodule:: bonobo.execution
|
||||
|
||||
:Module: :mod:`bonobo.execution`
|
||||
|
||||
.. toctree::
|
||||
:caption: Submodules
|
||||
:maxdepth: 1
|
||||
|
||||
execution/contexts
|
||||
execution/events
|
||||
execution/strategies
|
||||
|
||||
.. automodule:: bonobo.execution
|
||||
|
||||
|
||||
|
||||
10
docs/reference/api/bonobo/execution/contexts.rst
Normal file
10
docs/reference/api/bonobo/execution/contexts.rst
Normal file
@ -0,0 +1,10 @@
|
||||
:mod:`Execution Contexts <bonobo.execution.contexts>`
|
||||
=====================================================
|
||||
|
||||
.. currentmodule:: bonobo.execution.contexts
|
||||
|
||||
:Module: :mod:`bonobo.execution.contexts`
|
||||
|
||||
.. automodule:: bonobo.execution.contexts
|
||||
|
||||
|
||||
10
docs/reference/api/bonobo/execution/events.rst
Normal file
10
docs/reference/api/bonobo/execution/events.rst
Normal file
@ -0,0 +1,10 @@
|
||||
:mod:`Execution Events <bonobo.execution.events>`
|
||||
=================================================
|
||||
|
||||
.. currentmodule:: bonobo.execution.events
|
||||
|
||||
:Module: :mod:`bonobo.execution.events`
|
||||
|
||||
.. automodule:: bonobo.execution.events
|
||||
|
||||
|
||||
10
docs/reference/api/bonobo/execution/strategies.rst
Normal file
10
docs/reference/api/bonobo/execution/strategies.rst
Normal file
@ -0,0 +1,10 @@
|
||||
:mod:`Execution Strategies <bonobo.execution.strategies>`
|
||||
=========================================================
|
||||
|
||||
.. currentmodule:: bonobo.execution.strategies
|
||||
|
||||
:Module: :mod:`bonobo.execution.strategies`
|
||||
|
||||
.. automodule:: bonobo.execution.strategies
|
||||
|
||||
|
||||
10
docs/reference/api/bonobo/util.rst
Normal file
10
docs/reference/api/bonobo/util.rst
Normal file
@ -0,0 +1,10 @@
|
||||
:mod:`Util <bonobo.util>`
|
||||
=========================
|
||||
|
||||
.. currentmodule:: bonobo.util
|
||||
|
||||
:Module: :mod:`bonobo.util`
|
||||
|
||||
.. automodule:: bonobo.util
|
||||
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
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,10 +0,0 @@
|
||||
Util API
|
||||
========
|
||||
|
||||
The Util API, located under the :mod:`bonobo.util` namespace, contains helpers functions and decorators to work with
|
||||
and inspect transformations, graphs, and nodes.
|
||||
|
||||
.. automodule:: bonobo.util
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,15 +1,18 @@
|
||||
References
|
||||
==========
|
||||
Reference
|
||||
=========
|
||||
|
||||
Reference documents of all stable APIs and modules. If something is not here, please be careful about using it as it
|
||||
means that the api is not yet 1.0-proof.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 2
|
||||
|
||||
api
|
||||
api_config
|
||||
api_util
|
||||
api/bonobo
|
||||
api/bonobo/config
|
||||
api/bonobo/constants
|
||||
api/bonobo/execution
|
||||
api/bonobo/util
|
||||
commands
|
||||
settings
|
||||
examples
|
||||
private
|
||||
|
||||
Reference in New Issue
Block a user