Fix up docs a bit.

Browse Source
This commit is contained in:
Friedrich Lindenberg 2015-05-23 16:38:53 +02:00
parent aa4aebe73d
commit 1103946acd
5 changed files with 10 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -7,4 +7,8 @@ In short, **dataset** makes reading and writing data in databases as simple as r
[Read the docs](https://dataset.readthedocs.org/)
To install dataset, fetch it with ``pip``:
.. code-block:: bash
$ pip install dataset

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

@ -26,20 +26,4 @@
<img src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a>
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://piwik.vis4.net/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "17"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Piwik Code -->
{%- endblock %}

2
docs/_themes/kr/sidebarlogo.html vendored
View File

@ -2,7 +2,7 @@
<p style="font-style:italic;font-size:0.9em; text-align:center; margin-bottom:1.5em">Because managing databases in Python should be as simple as reading and writing JSON files.</p>
<iframe width="200px" scrolling="0" height="20px" frameborder="0" allowtransparency="true" src="http://ghbtns.com/github-btn.html?user=pudo&amp;repo=dataset&amp;type=watch&amp;count=true&amp;size=small"></iframe>
<iframe width="200px" scrolling="0" height="20px" frameborder="0" allowtransparency="true" src="https://ghbtns.com/github-btn.html?user=pudo&repo=dataset&type=watch&count=true&size=small"></iframe>
<h3>Overview</h3>

8
docs/conf.py
View File

@ -41,16 +41,16 @@ master_doc = 'index'
# General information about the project.
project = u'dataset'
copyright = u'2013, Friedrich Lindenberg, Gregor Aisch, Stefan Wehrmeyer'
copyright = u'2013-2015, Friedrich Lindenberg, Gregor Aisch, Stefan Wehrmeyer'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.5'
version = '0.6'
# The full version, including alpha/beta/rc tags.
release = '0.5'
release = '0.6.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -237,7 +237,7 @@ man_pages = [
# dir menu entry, description, category)
texinfo_documents = [
('index', 'dataset', u'dataset Documentation',
u'Friedrich Lindenberg, Gregor Aisch, Stefan Wehrmeyer', 'dataset', 'One line description of project.',
u'Friedrich Lindenberg, Gregor Aisch, Stefan Wehrmeyer', 'dataset', 'Databases for lazy people.',
'Miscellaneous'),
]

4
docs/install.rst
View File

@ -2,8 +2,6 @@
Installation Guide
==================
*— work in progress —*
The easiest way is to install ``dataset`` from the `Python Package Index <https://pypi.python.org/pypi/dataset/>`_ using ``pip`` or ``easy_install``:
.. code-block:: bash
@ -18,4 +16,4 @@ To install it manually simply download the repository from Github:
$ cd dataset/
$ python setup.py install
Depending on the type of database backend, you may also need to install a database specific driver package. For MySQL, this is ``MySQLdb``, for Postgres its ``psycopg2``. SQLite support is integrated into Python.
Depending on the type of database backend, you may also need to install a database specific driver package. For MySQL, this is ``MySQLdb``, for Postgres its ``psycopg2``. SQLite support is integrated into Python.