docs

Browse Source
This commit is contained in:
Gregor Aisch 2013-04-02 13:17:41 +02:00
parent 4d503f42e3
commit f52c7da45b
6 changed files with 36 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_static/knight_mozilla_on.jpg vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.8 KiB

18
docs/_themes/kr/layout.html vendored
View File

@ -7,13 +7,25 @@
{% endif %} {% endif %}
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
{% endblock %} {% endblock %}
{%- block relbar2 %}{% endblock %}
{% block sidebarlogo %}
<iframe width="200px" scrolling="0" height="35px" frameborder="0" allowtransparency="true" src="http://ghbtns.com/github-btn.html?user=pudo&amp;repo=dataset&amp;type=watch&amp;count=true&amp;size=large"></iframe>
{% endblock %}
{% block sidebar2 %}
{{ sidebar() }}
<a href="http://www.mozillaopennews.org/" style="position:relative;top:40px"><img src="_static/knight_mozilla_on.jpg" /></a>
{% endblock %}
{%- block footer %} {%- block footer %}
<div class="footer"> <div class="footer">
&copy; Copyright {{ copyright }}. &copy; Copyright {{ copyright }}.
</div> </div>
<a href="https://github.com/pudo/dataset" class="github"> <div>
<img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</div>
<a style="position: absolute; top: 0; right: 0; border: 0;" href="https://github.com/pudo/dataset" class="github">
<img src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a> </a>

16
docs/_themes/kr/static/flasky.css_t vendored
View File

@ -16,7 +16,7 @@
body { body {
font-family: "Georgia", "Open Sans", OpenSansRegular, sans-serif; font-family: "Georgia", "Open Sans", OpenSansRegular, sans-serif;
font-size: 16px; font-size: 16px;
background-color: white; background: #fff;
font-weight: 400; font-weight: 400;
color: #000; color: #000;
margin: 0; margin: 0;
@ -100,7 +100,7 @@ div.sphinxsidebarwrapper p.logo {
div.sphinxsidebar h3, div.sphinxsidebar h3,
div.sphinxsidebar h4 { div.sphinxsidebar h4 {
font-family: 'Antic Slab' ,'Garamond', 'Georgia', serif; font-family: 'Antic Slab' ,'Garamond', 'Georgia', serif;
color: #444; color: #000;
font-size: 24px; font-size: 24px;
font-weight: normal; font-weight: normal;
margin: 0 0 5px 0; margin: 0 0 5px 0;
@ -112,7 +112,7 @@ div.sphinxsidebar h4 {
} }
div.sphinxsidebar h3 a { div.sphinxsidebar h3 a {
color: #444; color: #000;
} }
div.sphinxsidebar p.logo a, div.sphinxsidebar p.logo a,
@ -157,11 +157,12 @@ div.body h3,
div.body h4, div.body h4,
div.body h5, div.body h5,
div.body h6 { div.body h6 {
font-family: 'Antic Slab', "Open Sans", OpenSansRegular, sans-serif; font-family: 'Antic Slab', serif;
font-weight: normal; font-weight: normal;
margin: 30px 0px 10px 0px; margin: 30px 0px 10px 0px;
padding: 0; padding: 0;
text-shadow: 1px 1px 3px #ddd; text-shadow: 1px 1px 3px #ddd;
color: #000;
} }
div.body h1 { margin-top: 0; padding-top: 0; font-size: 250%; } div.body h1 { margin-top: 0; padding-top: 0; font-size: 250%; }
@ -248,7 +249,7 @@ p.admonition-title:after {
pre { pre {
font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
font-size: 0.8em; font-size: 0.88em;
} }
tt { tt {
@ -542,3 +543,8 @@ a:hover tt {
.revsys-inline { .revsys-inline {
display: none!important; display: none!important;
} }
div.sphinxsidebar #searchbox input[type="text"] {
width: 140px;
padding: 4px 3px;
}

2
docs/conf.py
View File

@ -152,7 +152,7 @@ html_static_path = ['_static']
#html_split_index = False #html_split_index = False
# If true, links to the reST sources are added to the pages. # If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True #html_show_sphinx = True

25
docs/index.rst
View File

@ -3,8 +3,8 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
dataset: databases for humans dataset: databases for busy nerds
============================= =================================
Getting the databases out of your data's way:: Getting the databases out of your data's way::
@ -13,7 +13,8 @@ Getting the databases out of your data's way::
db = dataset.connect('sqlite:///weather.db') db = dataset.connect('sqlite:///weather.db')
db['temperature'].find() db['temperature'].find()
Features include: Features
--------
* **Automatic schema**. If a table or column is written that does not * **Automatic schema**. If a table or column is written that does not
exist in the database, it will be created automatically. exist in the database, it will be created automatically.
@ -22,20 +23,12 @@ Features include:
* **Query helpers** for simple queries such as all rows in a table or * **Query helpers** for simple queries such as all rows in a table or
all distinct values across a set of columns. all distinct values across a set of columns.
Contents
--------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Next steps: quickstart
api
* Quickstart: `Learn how to use dataset in five minutes <quickstart>`_
* API: `Browse the complete API docs <api>`_
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

3
docs/quickstart.rst
View File

@ -3,9 +3,6 @@ Quickstart
========== ==========
.. toctree::
:maxdepth: 2
Hi, welcome to the five-minute quick-start tutorial. Hi, welcome to the five-minute quick-start tutorial.
At first you need to import the dataset package :) :: At first you need to import the dataset package :) ::