Merge pull request #100 from rgommers/readme

MAINT: get README content on PyPI front page for new releases

Author: pv

README.rst

@@ -28,30 +28,30 @@ Options
 
 The following options can be set in conf.py:
 
-- numpydoc_use_plots: bool
+- ``numpydoc_use_plots``: bool
 
   Whether to produce ``plot::`` directives for Examples sections that
   contain ``import matplotlib``.
 
-- numpydoc_show_class_members: bool
+- ``numpydoc_show_class_members``: bool
 
   Whether to show all members of a class in the Methods and Attributes
   sections automatically.
   ``True`` by default.
 
-- numpydoc_show_inherited_class_members: bool
+- ``numpydoc_show_inherited_class_members``: bool
 
   Whether to show all inherited members of a class in the Methods and Attributes
   sections automatically. If it's false, inherited members won't shown.
   ``True`` by default.
 
-- numpydoc_class_members_toctree: bool
+- ``numpydoc_class_members_toctree``: bool
 
   Whether to create a Sphinx table of contents for the lists of class
   methods and attributes. If a table of contents is made, Sphinx expects
   each entry to have a separate page.
   ``True`` by default.
 
-- numpydoc_edit_link: bool  (DEPRECATED -- edit your HTML template instead)
+- ``numpydoc_edit_link``: bool  (DEPRECATED -- edit your HTML template instead)
 
   Whether to insert an edit link after docstrings.

setup.py

@@ -1,6 +1,7 @@
 from __future__ import division, print_function
 
 import sys
+import os
 
 from distutils.command.sdist import sdist
 import setuptools
@@ -15,11 +16,23 @@
             version = line.strip().split()[-1][1:-1]
             break
 
+def read(fname):
+    """Utility function to get README.rst into long_description.
+
+    ``long_description`` is what ends up on the PyPI front page.
+    """
+    with open(os.path.join(os.path.dirname(__file__), fname)) as f:
+        contents = f.read()
+
+    return contents
+
+
 setup(
     name="numpydoc",
     packages=["numpydoc"],
     version=version,
     description="Sphinx extension to support docstrings in Numpy format",
+    long_description=read('README.rst'),
     # classifiers from http://pypi.python.org/pypi?%3Aaction=list_classifiers
     classifiers=["Development Status :: 4 - Beta",
                  "Environment :: Plugins",