summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKenneth Reitz <me@kennethreitz.com>2011-02-10 10:18:30 -0500
committerKenneth Reitz <me@kennethreitz.com>2011-02-10 10:18:30 -0500
commit806aba9ef35e65226a6409afd17d7d3e0cb258f3 (patch)
tree943b012707e05ed9166d201a4d08c88f8272c55b /docs
parent23cbc0c3333a663f8d05076562858507c0dfe2f3 (diff)
downloadtablib-806aba9ef35e65226a6409afd17d7d3e0cb258f3.tar.gz
spelling corrections
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py14
-rw-r--r--docs/development.rst8
-rw-r--r--docs/index.rst2
-rw-r--r--docs/install.rst2
-rw-r--r--docs/intro.rst6
-rw-r--r--docs/tutorial.rst12
6 files changed, 29 insertions, 15 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 598cb68..47b6ee5 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -182,6 +182,20 @@ latex_documents = [
u'Kenneth Reitz', 'manual'),
]
+latex_use_modindex = False
+
+latex_elements = {
+ 'fontpkg': r'\usepackage{mathpazo}',
+ 'papersize': 'a4paper',
+ 'pointsize': '12pt',
+ 'preamble': r'\usepackage{krstyle}'
+}
+latex_use_parts = True
+
+latex_additional_files = ['krstyle.sty']
+
+
+
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
diff --git a/docs/development.rst b/docs/development.rst
index 5fb9c2b..77af330 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -128,7 +128,7 @@ Tablib features a micro-framework for adding format support. The easiest way to
.. admonition:: Excluding Support
- If the format excludes support for an import/export mechanism (*eg.* :class:`csv <tablib.Dataset.csv>` excludes :class:`Databook <tablib.Databook>` support), simply don't define the respecive functions. Appropriate errors will be raised.
+ If the format excludes support for an import/export mechanism (*eg.* :class:`csv <tablib.Dataset.csv>` excludes :class:`Databook <tablib.Databook>` support), simply don't define the respective functions. Appropriate errors will be raised.
2.
@@ -145,7 +145,7 @@ Tablib features a micro-framework for adding format support. The easiest way to
Testing Tablib
--------------
-Testing is crucial to Tablib's stability. This stable project is used in production by many companies and developers, so it is important to be certian that every version released is fully operational. When developing a new feature for Tablib, be sure to write proper tests for it as well.
+Testing is crucial to Tablib's stability. This stable project is used in production by many companies and developers, so it is important to be certain that every version released is fully operational. When developing a new feature for Tablib, be sure to write proper tests for it as well.
When developing a feature for Tablib, the easiest way to test your changes for potential issues is to simply run the test suite directly. ::
@@ -174,7 +174,7 @@ This will generate a **nosetests.xml** file, which can then be analyzed.
Continuous Integration
----------------------
-Every commit made to the **develop** branch is automatically tested and inspected upon receipt with `Hudson CI`_. If you have access to the main respository and broke the build, you will receive an email accordingly.
+Every commit made to the **develop** branch is automatically tested and inspected upon receipt with `Hudson CI`_. If you have access to the main repository and broke the build, you will receive an email accordingly.
Anyone may view the build status and history at any time.
@@ -197,7 +197,7 @@ Building the Docs
-----------------
Documentation is written in the powerful, flexible, and standard Python documentation format, `reStructured Text`_.
-Documentation builds are powered by the powerful Pocoo project, Sphinx_. The :ref:`API Documentation <api>` is mostly documented inline throught the module.
+Documentation builds are powered by the powerful Pocoo project, Sphinx_. The :ref:`API Documentation <api>` is mostly documented inline throughout the module.
The Docs live in ``tablib/docs``. In order to build them, you will first need to install Sphinx. ::
diff --git a/docs/index.rst b/docs/index.rst
index 4a4de40..4726d7b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -20,7 +20,7 @@ Tablib: Pythonic Tabular Data
.. * :ref:`search`
-Tablib is an :ref:`MIT Lisenced <mit>` format-agnostic tabular dataset library, written in Python. It allows you to import, export, and manipulate tabular data sets. Advanced features include, segregation, dynamic columns, tags & filtering, and seamless format import & exmport.
+Tablib is an :ref:`MIT Licensed <mit>` format-agnostic tabular dataset library, written in Python. It allows you to import, export, and manipulate tabular data sets. Advanced features include, segregation, dynamic columns, tags & filtering, and seamless format import & export.
I recommend you start with :ref:`Installation <install>`.
diff --git a/docs/install.rst b/docs/install.rst
index 0b5d212..9b9a519 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -2,7 +2,7 @@
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 enhancments <peed-extentions>`.
+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-extentions>`.
.. _installing:
diff --git a/docs/intro.rst b/docs/intro.rst
index a327d28..c2d75b2 100644
--- a/docs/intro.rst
+++ b/docs/intro.rst
@@ -4,7 +4,7 @@ Introduction
============
This part of the documentation covers all the interfaces of Tablib.
-Tablib is a format-agnostic tabular dataset library, written in Python. It allows you to Pythonically import, export, and manipulate tabular data sets. Advanced features include, segregation, dynamic columns, tags / filtering, and seamless format import/exmport.
+Tablib is a format-agnostic tabular dataset library, written in Python. It allows you to Pythonically import, export, and manipulate tabular data sets. Advanced features include, segregation, dynamic columns, tags / filtering, and seamless format import/export.
Philosphy
@@ -26,9 +26,9 @@ All contributions to Tablib should keep these important rules in mind.
MIT License
-----------
-A large number of open source projects you find today are `GPL Licensed`_. While the GPL certianly has essential applications, it should most certianly not be your go-to license for your next open source project.
+A large number of open source projects you find today are `GPL Licensed`_. While the GPL has its time and place, it should most certainly not be your go-to license for your next open source project.
-A project that is released as GPL cannot be usd in any commercial product without the product itself also being offered as open source. The MIT and BSD licenses are great alternatives to the GPL that allow your open-source software to be used in proprietary, closed-source software.
+A project that is released as GPL cannot be used in any commercial product without the product itself also being offered as open source. The MIT and BSD licenses are great alternatives to the GPL that allow your open-source software to be used in proprietary, closed-source software.
Tablib is released under terms of `The MIT License`_.
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
index dfe10ff..72b8792 100644
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@@ -103,7 +103,7 @@ Exporting Data
Tablib's killer feature is the ability to export your :class:`Dataset` objects into a number of formats.
-**Comma-Seperated Values** ::
+**Comma-Separated Values** ::
>>> data.csv
Last Name,First Name,Age
@@ -244,7 +244,7 @@ Filtering Datasets with Tags
When constructing a :class:`Dataset` object, you can add tags to rows by specifying the ``tags`` parameter.
-This allows you to filter your :class:`Dataset` later. This can be useful so seperate rows of data based on
+This allows you to filter your :class:`Dataset` later. This can be useful so separate rows of data based on
arbitrary criteria (*e.g.* origin) that you don't want to include in your :class:`Dataset`.
Let's tag some students. ::
@@ -268,7 +268,7 @@ It's that simple. The original :class:`Dataset` is untouched.
Excel Workbook With Multiple Sheets
------------------------------------
-When dealine with a large number of :class:`Datasets <Dataset>` in spreadsheet format, it's quite common to group mulitple spreadsheets into a single Excel file, known as a Workbook. Tablib makes it extremely easy to build webooks with the handy, :class:`Databook` class.
+When dealing with a large number of :class:`Datasets <Dataset>` in spreadsheet format, it's quite common to group multiple spreadsheets into a single Excel file, known as a Workbook. Tablib makes it extremely easy to build webooks with the handy, :class:`Databook` class.
Let's say we have 3 different :class:`Datasets <Dataset>`. All we have to do is add then to a :class:`Databook` object... ::
@@ -280,7 +280,7 @@ Let's say we have 3 different :class:`Datasets <Dataset>`. All we have to do is
with open('students.xls', 'wb') as f:
f.write(book.xls)
-The resulting **students.xls** file will contain a seperate spreadsheet for each :class:`Dataset` object in the :class:`Databook`.
+The resulting **students.xls** file will contain a separate spreadsheet for each :class:`Dataset` object in the :class:`Databook`.
.. admonition:: Binary Warning
@@ -295,7 +295,7 @@ Seperators
.. versionadded:: 0.8.2
-When, it's often useful to create a blank row containing information on the upcomming data. So,
+When, it's often useful to create a blank row containing information on the upcoming data. So,
@@ -346,7 +346,7 @@ The resulting **tests.xls** will have the following layout:
.. admonition:: Format Support
- At this time, only :class:`Excel <Dataset.xls>` output supports seperators.
+ At this time, only :class:`Excel <Dataset.xls>` output supports separators.
----