[Distutils] README file format and pypi.python.org

[Chris Jerdonek]

On Sun, Sep 22, 2013 at 2:15 PM, PJ Eby <pje at telecommunity.com> wrote:
> On Sun, Sep 22, 2013 at 9:01 AM, Paul G. <paul.list at isrcomputing.com> wrote:
>> 1. What format should I use in my README.txt file for my package's content
>> to be displayed on its package page?
>
> It's not the README file; it's the package's "long_description"
> keyword, as specified in your setup.py setup() call.  And the format
> is reStructuredText

For the record, the Python documentation covers this aspect of PyPI:

http://docs.python.org/distutils/packageindex.html#pypi-package-display

It also includes some troubleshooting info.  However, it doesn't
include anything about PyPI reading README.rst, etc if
long_description isn't available (which maybe should be added).

--Chris