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

Paul G. paul.list at isrcomputing.com
Sun Sep 22 15:01:12 CEST 2013


Hi everyone,

While playing around with packaging using Distutils2-py3, I created a package
called PyIdGen https://pypi.python.org/pypi/PyIdGen and added README.txt file.

I have seen that some packages have their documentation embedded into the
packages' corresponding package pages @ pypi.python.org.
For example, the 'py-postgresql 1.1.0' module @
'https://pypi.python.org/pypi/py-postgresql/1.1.0' has its documentation on its
package page.

A few questions:
1. What format should I use in my README.txt file for my package's content to be
displayed on its package page?
2. Do I have to use a different extension for the README?

Regards,
Paul G.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/distutils-sig/attachments/20130922/f295413e/attachment.html>


More information about the Distutils-SIG mailing list