summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKenneth Reitz <me@kennethreitz.com>2010-10-08 11:49:53 -0400
committerKenneth Reitz <me@kennethreitz.com>2010-10-08 11:49:53 -0400
commit55eb3f93e37141ed33455bc4b7db4b6f721445fd (patch)
tree469f6bbae68a614ea2ff52817a75db888b8121e4 /docs
parentbe7182aea958520a9a2c37ae05130c88119f4e8d (diff)
downloadtablib-55eb3f93e37141ed33455bc4b7db4b6f721445fd.tar.gz
documentation update
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py2
-rw-r--r--docs/index.rst2
-rw-r--r--docs/install.rst30
3 files changed, 18 insertions, 16 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 4d80fe7..b340f43 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -120,7 +120,7 @@ html_theme = 'default'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
diff --git a/docs/index.rst b/docs/index.rst
index 058335e..75cbbe2 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -22,7 +22,7 @@ Welcome to Tablib's docuemtation.
.. * :ref:`search`
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+Tablib is a format-agnostic tabular dataset library, written in Python. It allows you to import, export, and manipulate tabular data sets.
I recommend you start off with `Installation`.
diff --git a/docs/install.rst b/docs/install.rst
index ac6caf1..d1cacbf 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -3,10 +3,7 @@
Installation
============
-This part of the documentation covers all the interfaces of Tablib. For
-parts where Tablib depends on external libraries, we document the most
-important right here and provide links to the canonical documentation.
-
+This part of the documentation covers the installation of Tablib. The first step to using any software package is getting it properly installed. Please read this section carefully, or you may miss out on some nice :ref:`speed enhancments <speed>`..
Installing Tablib
-----------------
@@ -21,26 +18,30 @@ Or, if you must: ::
But, you really shouldn't do that.
+.. _speed:
+
Speed Extentions
----------------
+.. versionadded:: 0.8.5
+
Tablib is partially dependent on the **pyyaml**, **simplejson**, and **xlwt** modules. To reduce installation issues, fully integrated versions of all required libraries are included in Tablib.
-However, if performance is important to you (and it should be), you should install **simplejson** and **pyyaml** with C extentions from PyPi. ::
+However, if performance is important to you (and it should be), you can install **pyyaml** with C extentions from PyPi. ::
$ pip install PyYAML
-If you're using Python 2.6+, the built-in **json** module is already optimized and in use. If you're using Python 2.5 (currently unsupported), you should also install the **simplejson** module. ::
+If you're using Python 2.5 (currently unsupported), you should also install the **simplejson** module. If you're using Python 2.6+, the built-in **json** module is already optimized and in use. ::
$ pip install simplejson
-.. If you're using a Python < 2.6, you can speed up JSON
+
Pythons Supported
-----------------
-At this time, only the following Python platforms are officially supported:
+At this time, the following Python platforms are officially supported:
* Python 2.6
* Python 2.7
@@ -49,14 +50,15 @@ Support for other Pythons will be rolled out soon.
+Staying Updated
+---------------
-Virtualenv
-----------
+The latest version of Tablib will always be available here:
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+* PyPi: http://pypi.python.org/pypi/tablib/
+* GitHub: http://github.com/kennethreitz/tablib/
+When a new version is available, upgrading is simple. ::
-Staying Updated
----------------
+ $ pip install tablib --upgrade
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. \ No newline at end of file