paulin/bonobo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixes packaging: *.py-tpl are now included using recursive-include in MANIFEST.in

Browse Source
This commit is contained in:
Romain Dorgueil
2017-12-03 09:57:56 +01:00
parent 23374e7d58
commit e39ab0e62e
6 changed files with 27 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/_static/custom.css vendored
View File

@ -19,28 +19,10 @@ div.related {
font-size: 0.9em;
}
div.sphinxsidebar h1,
div.sphinxsidebar h2,
div.sphinxsidebar h3,
div.sphinxsidebar h4,
div.sphinxsidebar h5,
div.sphinxsidebar h6 {
font-family: 'Ubuntu', 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
}
div.sphinxsidebar h3 {
margin: 30px 0 10px 0;
}
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: 'Ubuntu', 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
}
div.admonition p.admonition-title {
font-family: 'Ubuntu', 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
}

5
docs/_templates/sidebarintro.html vendored
View File

@ -1,9 +1,6 @@
<h3>About Bonobo</h3>
<p>
Bonobo is a data-processing toolkit for python 3.5+.
</p>
<p>
It's a swiss-army knife for everyday's data.
Bonobo is a data-processing toolkit for python 3.5+, your swiss-army knife for everyday's data.
</p>
<h3>Other Formats</h3>

24
docs/install.rst
View File

@ -35,13 +35,6 @@ Now, you can head to :doc:`tutorial/index`.
along with pointers on how to move this first file into an existing fully
featured python package.
You can also avoid all the comments boilerplate by using `--bare` option
(which is a shorthand for `--template bare`):
.. code-block:: shell-session
$ bonobo init --bare my-bare-etl-job.py
Other installation options
::::::::::::::::::::::::::
@ -55,6 +48,12 @@ You can install it directly from the `Python Package Index <https://pypi.python.
$ pip install bonobo
To upgrade an existing installation, use `--upgrade`:
.. code-block:: shell-session
$ pip install --upgrade bonobo
Install from source
-------------------
@ -119,6 +118,17 @@ I usually name the git remote for the main bonobo repository "upstream", and my
Of course, replace my github username by the one you used to fork bonobo. You should be good to go!
Preview versions
----------------
Sometimes, there are pre-versions available (before a major release, for example). By default, pip does not target
pre-versions to avoid accidental upgrades to a potentially instable software, but you can easily opt-in:
.. code-block:: shell-session
$ pip install --upgrade --pre bonobo
Supported platforms
:::::::::::::::::::

12
docs/tutorial/index.rst
View File

@ -39,12 +39,16 @@ More
What's next?
::::::::::::
* :doc:`The Bonobo Guide <../guide/index>`
* :doc:`Extensions <../extension/index>`
Once you're familiar with all the base concepts, you can...
* Read the :doc:`Guides </guide/index>` to have a deep dive in each concept.
* Explore the :doc:`Extensions </extension/index>` to widen the possibilities.
* Open the :doc:`References </reference/index>` and start hacking like crazy.
We're there!
::::::::::::
You're not alone!
:::::::::::::::::
Good documentation is not easy to write.