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

Documentation cosmetics.

Browse Source
This commit is contained in:
Romain Dorgueil
2017-11-28 21:57:48 +01:00
parent 686d1c81b3
commit c7ff06a742
5 changed files with 91 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/_static/custom.css vendored
View File

@ -16,4 +16,50 @@ div.related {
.brand {
font-family: 'Ubuntu', 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
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;
}
div.sphinxsidebarwrapper {
padding: 0;
}
div.note {
border: 0;
}
div.admonition {
padding: 20px;
}
.last {
margin-bottom: 0 !important;
}
pre {
padding: 6px 20px;
}

20
docs/_templates/sidebarintro.html vendored
View File

@ -1,22 +1,24 @@
<h3>About Bonobo</h3>
<p>
Bonobo is a data-processing toolkit for python 3.5+, with emphasis on simplicity, atomicity and testability. Oh,
and performances, too!
Bonobo is a data-processing toolkit for python 3.5+.
</p>
<p>
It's a swiss-army knife for everyday's data.
</p>
<h3>Other Formats</h3>
<p>
You can download the documentation in other formats as well:
Download the docs...
</p>
<ul>
<li><a href="http://readthedocs.org/projects/bonobo/downloads/pdf/master/">as PDF</a></li>
<li><a href="http://readthedocs.org/projects/bonobo/downloads/htmlzip/master/">as zipped HTML</a></li>
<li><a href="http://readthedocs.org/projects/bonobo/downloads/epub/master/">as EPUB</a></li>
<li><a href="http://readthedocs.org/projects/bonobo/downloads/pdf/master/" title="Bonobo ETL documentation as PDF">... as PDF</a></li>
<li><a href="http://readthedocs.org/projects/bonobo/downloads/htmlzip/master/" title="Bonobo ETL documentation as zipped HTML">... as zipped HTML</a></li>
<li><a href="http://readthedocs.org/projects/bonobo/downloads/epub/master/" title="Bonobo ETL documentation as EPUB">... as EPUB</a></li>
</ul>
<h3>Useful Links</h3>
<ul>
<li><a href="https://www.bonobo-project.org/">Bonobo ETL</a></li>
<li><a href="http://pypi.python.org/pypi/bonobo">Bonobo ETL @ PyPI</a></li>
<li><a href="http://github.com/python-bonobo/bonobo">Bonobo ETL @ GitHub</a></li>
<li><a href="https://www.bonobo-project.org/">Bonobo's homepage</a></li>
<li><a href="http://pypi.python.org/pypi/bonobo">Package on PyPI</a></li>
<li><a href="http://github.com/python-bonobo/bonobo">Source code on GitHub</a></li>
</ul>

4
docs/_templates/sidebarlogo.html vendored
View File

@ -1,12 +1,12 @@
<a href="{{ pathto(master_doc) }}" style="border: none">
<h1 style="text-align: center; margin: 0;">
<img class="logo" src="{{ pathto('_static/bonobo.png', 1) }}" title="Bonobo" style="width: 48px; height: 48px; vertical-align: bottom"/>
<img class="logo" src="{{ pathto('_static/bonobo.png', 1) }}" title="Bonobo" style="width: 40px; height: 40px; vertical-align: bottom"/>
<span class="brand">
Bonobo
</span>
</h1>
</a>
<p style="text-align: center">
<p style="text-align: center" class="first">
Data processing for humans.
</p>

2
docs/conf.py
View File

@ -189,7 +189,7 @@ intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
rst_epilog = """
.. |bonobo| replace:: **Bonobo**
.. |longversion| replace:: v.{version}
""".format(

39
docs/install.rst
View File

@ -1,23 +1,47 @@
Installation
============
Create an ETL project
:::::::::::::::::::::
Let's create a job.
First, install the framework:
.. code-block:: shell-session
$ pip install --upgrade bonobo
$ bonobo create my-etl.py
Create a simple job:
.. code-block:: shell-session
$ bonobo init my-etl.py
And let's go for a test drive:
.. code-block:: shell-session
$ python my-etl.py
This job only uses one python file, and you can run it using the python interpreter. For bigger jobs or jobs that
relates to multiple files, you should create a python package.
Congratulations, you ran your first Bonobo ETL job.
Now, you can head to :doc:`tutorial/index`.
.. note::
It's often best to start with a single file then move it into a project
(which, in python, needs to live in a package).
You can read more about this topic in the :doc:`guide/packaging` section,
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
::::::::::::::::::::::::::
@ -83,12 +107,12 @@ from the local clone.
  $ git clone git@github.com:python-bonobo/bonobo.git
$ cd bonobo
$ pip install --editable .
You can develop on this clone, but you probably want to add your own repository if you want to push code back and make pull requests.
I usually name the git remote for the main bonobo repository "upstream", and my own repository "origin".
.. code-block:: shell-session
$ git remote rename origin upstream
$ git remote add origin git@github.com:hartym/bonobo.git
$ git fetch --all
@ -119,4 +143,3 @@ users.
We're trying to look into that but energy available to provide serious support on windows is very limited.
If you have experience in this domain and you're willing to help, you're more than welcome!