diff --git a/README.md b/README.md index 316dc3d..38f0008 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/_themes/kr/layout.html b/docs/_themes/kr/layout.html index 7b67150..be68ab2 100755 --- a/docs/_themes/kr/layout.html +++ b/docs/_themes/kr/layout.html @@ -26,20 +26,4 @@ Fork me on GitHub - - - - {%- endblock %} diff --git a/docs/_themes/kr/sidebarlogo.html b/docs/_themes/kr/sidebarlogo.html index 5f088f8..ee2aaf9 100644 --- a/docs/_themes/kr/sidebarlogo.html +++ b/docs/_themes/kr/sidebarlogo.html @@ -2,7 +2,7 @@

Because managing databases in Python should be as simple as reading and writing JSON files.

- +

Overview

diff --git a/docs/conf.py b/docs/conf.py index 0e364cc..020b702 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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'), ] diff --git a/docs/install.rst b/docs/install.rst index d0db56c..b1d88de 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -2,8 +2,6 @@ Installation Guide ================== -*— work in progress —* - The easiest way is to install ``dataset`` from the `Python Package Index `_ 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. \ No newline at end of file +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.