Sweeping the docs.
This commit is contained in:
@ -1,6 +1,21 @@
|
||||
Contributing
|
||||
============
|
||||
|
||||
There's a lot of different ways you can contribute, and not all of them includes coding. Do not think that the codeless
|
||||
contributions have less value, all contributions are very important.
|
||||
|
||||
* You can contribute to the documentation.
|
||||
* You can help reproducing errors and giving more infos in the issues.
|
||||
* You can open issues with problems you're facing.
|
||||
* You can help creating better presentation material.
|
||||
* You can talk about it in your local python user group.
|
||||
* You can enhance examples.
|
||||
* You can enhance tests.
|
||||
* etc.
|
||||
|
||||
Code-related contributions (including tests and examples)
|
||||
:::::::::::::::::::::::::::::::::::::::::::::::::::::::::
|
||||
|
||||
Contributing to bonobo is usually done this way:
|
||||
|
||||
* Discuss ideas in the `issue tracker <https://github.com/python-bonobo/bonobo>`_ or on `Slack <https://bonobo-slack.herokuapp.com/>`_.
|
||||
|
||||
@ -22,5 +22,6 @@ available as an optional extra dependency, and the maturity stage of each extens
|
||||
:maxdepth: 2
|
||||
|
||||
ext/docker
|
||||
ext/jupyter
|
||||
ext/selenium
|
||||
ext/sqlalchemy
|
||||
|
||||
@ -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
|
||||
|
||||
@ -10,7 +10,7 @@ We strongly advice that even if you're an advanced python developper, you go thr
|
||||
reasons: that should be sufficient to do anything possible with **Bonobo** and that's a good moment to learn the few
|
||||
concepts you'll see everywhere in the software.
|
||||
|
||||
If you're not familiar with python, you should first read :doc:`./python`.
|
||||
If you're not familiar with python, you should first read :doc:`python`.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@ -6,16 +6,6 @@ Just enough Python for Bonobo
|
||||
This is a work in progress and it is not yet available. Please come back later or even better, help us write this
|
||||
guide!
|
||||
|
||||
This guide is intended to help programmers or enthusiasts to grasp the python basics necessary to use Bonobo. It should
|
||||
definately not be considered as a general python introduction, neither a deep dive into details.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
python01
|
||||
python02
|
||||
python03
|
||||
python04
|
||||
python05
|
||||
|
||||
This guide is intended to help programmers or enthusiasts to grasp the python basics necessary to use Bonobo. It
|
||||
should definately not be considered as a general python introduction, neither a deep dive into details.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user