Skip to content

Commit 62f56c2

Browse files
rgommerspv
authored andcommitted
DOC: pipe README.rst contents into long_description, for PyPI frontpage
1 parent be8d5ac commit 62f56c2

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

setup.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
from __future__ import division, print_function
22

33
import sys
4+
import os
45

56
from distutils.command.sdist import sdist
67
import setuptools
@@ -15,11 +16,23 @@
1516
version = line.strip().split()[-1][1:-1]
1617
break
1718

19+
def read(fname):
20+
"""Utility function to get README.rst into long_description.
21+
22+
``long_description`` is what ends up on the PyPI front page.
23+
"""
24+
with open(os.path.join(os.path.dirname(__file__), fname)) as f:
25+
contents = f.read()
26+
27+
return contents
28+
29+
1830
setup(
1931
name="numpydoc",
2032
packages=["numpydoc"],
2133
version=version,
2234
description="Sphinx extension to support docstrings in Numpy format",
35+
long_description=read('README.rst'),
2336
# classifiers from http://pypi.python.org/pypi?%3Aaction=list_classifiers
2437
classifiers=["Development Status :: 4 - Beta",
2538
"Environment :: Plugins",

0 commit comments

Comments
 (0)