Documentation cosmetics.
This commit is contained in:
46
docs/_static/custom.css
vendored
46
docs/_static/custom.css
vendored
@ -16,4 +16,50 @@ div.related {
|
|||||||
|
|
||||||
.brand {
|
.brand {
|
||||||
font-family: 'Ubuntu', 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
|
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
20
docs/_templates/sidebarintro.html
vendored
@ -1,22 +1,24 @@
|
|||||||
<h3>About Bonobo</h3>
|
<h3>About Bonobo</h3>
|
||||||
<p>
|
<p>
|
||||||
Bonobo is a data-processing toolkit for python 3.5+, with emphasis on simplicity, atomicity and testability. Oh,
|
Bonobo is a data-processing toolkit for python 3.5+.
|
||||||
and performances, too!
|
</p>
|
||||||
|
<p>
|
||||||
|
It's a swiss-army knife for everyday's data.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h3>Other Formats</h3>
|
<h3>Other Formats</h3>
|
||||||
<p>
|
<p>
|
||||||
You can download the documentation in other formats as well:
|
Download the docs...
|
||||||
</p>
|
</p>
|
||||||
<ul>
|
<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/pdf/master/" title="Bonobo ETL documentation as PDF">... 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/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/">as EPUB</a></li>
|
<li><a href="http://readthedocs.org/projects/bonobo/downloads/epub/master/" title="Bonobo ETL documentation as EPUB">... as EPUB</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3>Useful Links</h3>
|
<h3>Useful Links</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="https://www.bonobo-project.org/">Bonobo ETL</a></li>
|
<li><a href="https://www.bonobo-project.org/">Bonobo's homepage</a></li>
|
||||||
<li><a href="http://pypi.python.org/pypi/bonobo">Bonobo ETL @ PyPI</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">Bonobo ETL @ GitHub</a></li>
|
<li><a href="http://github.com/python-bonobo/bonobo">Source code on GitHub</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|||||||
4
docs/_templates/sidebarlogo.html
vendored
4
docs/_templates/sidebarlogo.html
vendored
@ -1,12 +1,12 @@
|
|||||||
<a href="{{ pathto(master_doc) }}" style="border: none">
|
<a href="{{ pathto(master_doc) }}" style="border: none">
|
||||||
<h1 style="text-align: center; margin: 0;">
|
<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">
|
<span class="brand">
|
||||||
Bonobo
|
Bonobo
|
||||||
</span>
|
</span>
|
||||||
</h1>
|
</h1>
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<p style="text-align: center">
|
<p style="text-align: center" class="first">
|
||||||
Data processing for humans.
|
Data processing for humans.
|
||||||
</p>
|
</p>
|
||||||
|
|||||||
@ -1,23 +1,47 @@
|
|||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
|
|
||||||
|
|
||||||
Create an ETL project
|
Create an ETL project
|
||||||
:::::::::::::::::::::
|
:::::::::::::::::::::
|
||||||
|
|
||||||
Let's create a job.
|
First, install the framework:
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block:: shell-session
|
||||||
|
|
||||||
$ pip install --upgrade bonobo
|
$ 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
|
$ 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
|
Congratulations, you ran your first Bonobo ETL job.
|
||||||
relates to multiple files, you should create a python package.
|
|
||||||
|
|
||||||
Now, you can head to :doc:`tutorial/index`.
|
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
|
Other installation options
|
||||||
::::::::::::::::::::::::::
|
::::::::::::::::::::::::::
|
||||||
@ -119,4 +143,3 @@ users.
|
|||||||
We're trying to look into that but energy available to provide serious support on windows is very limited.
|
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!
|
If you have experience in this domain and you're willing to help, you're more than welcome!
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user