more docs, still wip

This commit is contained in:
Romain Dorgueil
2016-12-27 22:05:21 +01:00
parent 4e2e9fa140
commit ad36f9368a
20 changed files with 560 additions and 106 deletions

View File

@ -0,0 +1,22 @@
bonobo.compat package
=====================
Submodules
----------
bonobo.compat.pandas module
---------------------------
.. automodule:: bonobo.compat.pandas
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.compat
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,85 @@
bonobo.core package
===================
Subpackages
-----------
.. toctree::
bonobo.core.strategies
Submodules
----------
bonobo.core.bags module
-----------------------
.. automodule:: bonobo.core.bags
:members:
:undoc-members:
:show-inheritance:
bonobo.core.contexts module
---------------------------
.. automodule:: bonobo.core.contexts
:members:
:undoc-members:
:show-inheritance:
bonobo.core.errors module
-------------------------
.. automodule:: bonobo.core.errors
:members:
:undoc-members:
:show-inheritance:
bonobo.core.graphs module
-------------------------
.. automodule:: bonobo.core.graphs
:members:
:undoc-members:
:show-inheritance:
bonobo.core.inputs module
-------------------------
.. automodule:: bonobo.core.inputs
:members:
:undoc-members:
:show-inheritance:
bonobo.core.plugins module
--------------------------
.. automodule:: bonobo.core.plugins
:members:
:undoc-members:
:show-inheritance:
bonobo.core.services module
---------------------------
.. automodule:: bonobo.core.services
:members:
:undoc-members:
:show-inheritance:
bonobo.core.stats module
------------------------
.. automodule:: bonobo.core.stats
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.core
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,38 @@
bonobo.core.strategies package
==============================
Submodules
----------
bonobo.core.strategies.base module
----------------------------------
.. automodule:: bonobo.core.strategies.base
:members:
:undoc-members:
:show-inheritance:
bonobo.core.strategies.executor module
--------------------------------------
.. automodule:: bonobo.core.strategies.executor
:members:
:undoc-members:
:show-inheritance:
bonobo.core.strategies.naive module
-----------------------------------
.. automodule:: bonobo.core.strategies.naive
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.core.strategies
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,22 @@
bonobo.ext.console package
==========================
Submodules
----------
bonobo.ext.console.plugin module
--------------------------------
.. automodule:: bonobo.ext.console.plugin
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.ext.console
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,30 @@
bonobo.ext.jupyter package
==========================
Submodules
----------
bonobo.ext.jupyter.plugin module
--------------------------------
.. automodule:: bonobo.ext.jupyter.plugin
:members:
:undoc-members:
:show-inheritance:
bonobo.ext.jupyter.widget module
--------------------------------
.. automodule:: bonobo.ext.jupyter.widget
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.ext.jupyter
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,46 @@
bonobo.ext package
==================
Subpackages
-----------
.. toctree::
bonobo.ext.console
bonobo.ext.jupyter
Submodules
----------
bonobo.ext.couchdb_ module
--------------------------
.. automodule:: bonobo.ext.couchdb_
:members:
:undoc-members:
:show-inheritance:
bonobo.ext.opendatasoft module
------------------------------
.. automodule:: bonobo.ext.opendatasoft
:members:
:undoc-members:
:show-inheritance:
bonobo.ext.selenium module
--------------------------
.. automodule:: bonobo.ext.selenium
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.ext
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,30 @@
bonobo.io package
=================
Submodules
----------
bonobo.io.file module
---------------------
.. automodule:: bonobo.io.file
:members:
:undoc-members:
:show-inheritance:
bonobo.io.json module
---------------------
.. automodule:: bonobo.io.json
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.io
:members:
:undoc-members:
:show-inheritance:

21
docs/reference/bonobo.rst Normal file
View File

@ -0,0 +1,21 @@
bonobo package
==============
Subpackages
-----------
.. toctree::
bonobo.compat
bonobo.core
bonobo.ext
bonobo.io
bonobo.util
Module contents
---------------
.. automodule:: bonobo
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,62 @@
bonobo.util package
===================
Submodules
----------
bonobo.util.compat module
-------------------------
.. automodule:: bonobo.util.compat
:members:
:undoc-members:
:show-inheritance:
bonobo.util.helpers module
--------------------------
.. automodule:: bonobo.util.helpers
:members:
:undoc-members:
:show-inheritance:
bonobo.util.iterators module
----------------------------
.. automodule:: bonobo.util.iterators
:members:
:undoc-members:
:show-inheritance:
bonobo.util.lifecycle module
----------------------------
.. automodule:: bonobo.util.lifecycle
:members:
:undoc-members:
:show-inheritance:
bonobo.util.time module
-----------------------
.. automodule:: bonobo.util.time
:members:
:undoc-members:
:show-inheritance:
bonobo.util.tokens module
-------------------------
.. automodule:: bonobo.util.tokens
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bonobo.util
:members:
:undoc-members:
:show-inheritance:

13
docs/reference/index.rst Normal file
View File

@ -0,0 +1,13 @@
References
==========
.. todo:: write the fucking doc!
.. toctree::
:maxdepth: 4
bonobo
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -0,0 +1,3 @@
bonobo
======