updating docs

docs/conf.py

@@ -117,12 +117,17 @@ todo_include_todos = True
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+html_theme_options = {
+    'description': 'Pretty printing of tabular data',
+    'github_user': 'nirum',
+    'github_repo': 'tableprint',
+    'fixed_sidebar': True,
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []

docs/index.rst

@@ -1,14 +1,16 @@
+==========
 Tableprint
-----------
+==========
 
-Tableprint is a library for printing out numerical data in Ascii formatted tables. Check it out on `Github`_!
+About
+-----
+Tableprint is a library for printing out numerical data in Ascii formatted tables. Check it out on `github`. You can use it to print single rows of data at a time (useful for printing ongoing computation results).
 
 .. _Github: https://github.com/nirum/tableprint/
 
 Installation
 ------------
-
-First, we need to install the module. We can do that using ``pip``: 
+Using ``pip``: 
 
 .. code-block:: bash
 
@@ -16,8 +18,7 @@ First, we need to install the module. We can do that using ``pip``:
 
 Quickstart
 ----------
-
-Now let's see what we can do. Tableprint offers two functions that print a table directly,
+Tableprint offers two functions that print a table directly,
 ``tableprint.table`` and ``tableprint.dataframe``. The first takes a numpy array and a list of
 headers, whereas the second takes a pandas DataFrame as input. For example, you can do the following:
 
@@ -53,10 +54,8 @@ what unicode or ascii characters to use to build the table. The available styles
 
 API
 ---
-
-Tableprint comes with a number of options, these are fully described below:
-
 .. autofunction:: tableprint.table
+.. autofunction:: tableprint.TableContext
 .. autofunction:: tableprint.dataframe
 .. autofunction:: tableprint.banner
 .. autofunction:: tableprint.header