summaryrefslogtreecommitdiff
path: root/docs/install.rst
diff options
context:
space:
mode:
authorJean Jordaan <jean.jordaan@gmail.com>2016-07-31 18:15:12 +0700
committerJean Jordaan <jean.jordaan@gmail.com>2016-07-31 18:15:12 +0700
commita4f974287b225f220ca567f960f30ce5e33d1f77 (patch)
treecde0bc89d1d52f39d60e1c590eb95a9aac73f043 /docs/install.rst
parentf59abe84be6197e8675bc8d04e65ee7b820f4d52 (diff)
downloadtablib-a4f974287b225f220ca567f960f30ce5e33d1f77.tar.gz
Editing while reading: punctuation, markup, linebreaks
I fixed some extra commas, missing apostrophes, and typos; added some linebreaks between sentences for very long lines; added explicit markup for console blocks, got rid of some tabs, fixed indentation of an admonition, and some more small tweaks. This supersedes https://github.com/kennethreitz/tablib/pull/84
Diffstat (limited to 'docs/install.rst')
-rw-r--r--docs/install.rst32
1 files changed, 24 insertions, 8 deletions
diff --git a/docs/install.rst b/docs/install.rst
index 7b0b00b..c332325 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -2,7 +2,9 @@
Installation
============
-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 enhancements <peed-extensions>`.
+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 enhancements <peed-extensions>`.
.. _installing:
@@ -14,7 +16,8 @@ Installing Tablib
Distribute & Pip
----------------
-Of course, the recommended way to install Tablib is with `pip <http://www.pip-installer.org/>`_::
+Of course, the recommended way to install Tablib is with `pip <http://www.pip-installer.org/>`_:
+.. code-block:: console
$ pip install tablib
@@ -23,13 +26,19 @@ Of course, the recommended way to install Tablib is with `pip <http://www.pip-in
Download the Source
-------------------
-You can also install tablib from source. The latest release (|version|) is available from GitHub.
+You can also install tablib from source.
+The latest release (|version|) is available from GitHub.
* tarball_
* zipball_
.. _
-Once you have a copy of the source, you can embed it in your Python package, or install it into your site-packages easily. ::
+
+Once you have a copy of the source,
+you can embed it in your Python package,
+or install it into your site-packages easily.
+
+.. code-block:: console
$ python setup.py install
@@ -46,25 +55,32 @@ Speed Extensions
.. 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.
+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 can install **pyyaml** with C extensions from PyPi.
-However, if performance is important to you (and it should be), you can install **pyyaml** with C extensions from PyPi. ::
+.. code-block:: console
$ pip install PyYAML
-If you're using Python 2.5, you should also install the **simplejson** module (pip will do this for you). 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, you should also install the **simplejson** module (pip will do this for you).
+If you're using Python 2.6+, the built-in **json** module is already optimized and in use.
+
+.. code-block:: console
$ pip install simplejson
.. _updates:
+
Staying Updated
---------------
The latest version of Tablib will always be available here:
-* PyPi: http://pypi.python.org/pypi/tablib/
+* PyPI: http://pypi.python.org/pypi/tablib/
* GitHub: http://github.com/kennethreitz/tablib/
When a new version is available, upgrading is simple::