Refreshed README.rst.

cjw296 · cjw296 · commit 72a01f4b5e3d · 2016-06-05T23:29:13.000-05:00
Drops need for separate description.rst.
diff --git a/README.rst b/README.rst
@@ -1,13 +1,74 @@
-=======
+|Travis|_ |Coveralls|_ |Docs|_ |PyPI|_
+
+.. |Travis| image:: https://api.travis-ci.org/python-excel/xlutils.svg?branch=master
+.. _Travis: https://travis-ci.org/python-excel/xlutils
+
+.. |Coveralls| image:: https://coveralls.io/repos/python-excel/xlutils/badge.svg?branch=master
+.. _Coveralls: https://coveralls.io/r/python-excel/xlutils?branch=master
+
+.. |Docs| image:: https://readthedocs.org/projects/xlutils/badge/?version=latest
+.. _Docs: http://xlutils.readthedocs.org/en/latest/
+
+.. |PyPI| image:: https://badge.fury.io/py/xlutils.svg
+.. _PyPI: https://badge.fury.io/py/xlutilsxlutils
+    
 xlutils
 =======
 
+This package provides a collection of utilities for working with Excel
+files. Since these utilities may require either or both of the xlrd
+and xlwt packages, they are collected together here, separate from either
+package.
+
+Currently available are:
+
+**xlutils.copy**
+  Tools for copying xlrd.Book objects to xlwt.Workbook objects.
+
+**xlutils.display**
+  Utility functions for displaying information about xlrd-related
+  objects in a user-friendly and safe fashion.
+
+**xlutils.filter**
+  A mini framework for splitting and filtering Excel files into new
+  Excel files.
+
+**xlutils.margins**
+  Tools for finding how much of an Excel file contains useful data.
+
+**xlutils.save**
+  Tools for serializing xlrd.Book objects back to Excel files.
+
+**xlutils.styles**
+  Tools for working with formatting information expressed in styles.
+
+Installation
+============
+
+Do the following in your virtualenv::
+
+  pip install xlutils
+
 For full documentation please see:
 http://www.simplistix.co.uk/software/python/xlutils
 
 If working offline, please consult the documentation source in the
 `docs` directory.
 
+Documentation
+=============
+
+The latest documentation can also be found at:
+http://xlutils.readthedocs.org/en/latest/
+
+Problems?
+=========
+Try the following in this order:
+
+- Read the source
+
+- Ask a question on http://groups.google.com/group/python-excel/
+
 Licensing
 =========
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -24,7 +24,6 @@
 copyright = '2008-%s Simplistix Ltd' % datetime.datetime.now().year
 version = release = pkg_info.version
 exclude_trees = ['_build']
-unused_docs = ['description']
 pygments_style = 'sphinx'
 
 # Options for HTML output
diff --git a/docs/description.rst b/docs/description.rst
diff --git a/setup.py b/setup.py
@@ -11,12 +11,12 @@
 
 setup(
     name='xlutils',
-    version=file(os.path.join(base_dir, name, 'version.txt')).read().strip(),
+    version=open(os.path.join(base_dir, name, 'version.txt')).read().strip(),
     author='Chris Withers',
     author_email='chris@simplistix.co.uk',
     license='MIT',
     description="Utilities for working with Excel files that require both xlrd and xlwt",
-    long_description=open(os.path.join(base_dir, 'docs', 'description.rst')).read(),
+    long_description=open(os.path.join(base_dir, 'README.rst')).read(),
     url='http://www.python-excel.org',
     keywords="excel xls xlrd xlwt",
     classifiers=[
