Search code examples
pythonpackagingpypi

How to set up "front page" documentation on PYPI for a project?

I would like to add basic documentation content to the front page of PYPI of my module like it's done, for example, here: http://pypi.python.org/pypi/Jinja2.

Right now the askbot download page has a default look and does not have much useful info, how can it be added? That is - which parts of the distribution package files/which file must be edited?

Thanks!

Solution

  • Did you take a look at : http://pypi.python.org/pypi/an_example_pypi_project

    Also PyPI attempts to parse the "long_description" from your meta-data as ReStructuredText. You could use that to provide a good information rendering.