Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

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!

like image 919
Evgeny Avatar asked Nov 19 '10 02:11

Evgeny


People also ask

Which files are included initially in the PyPI to configure a Python project?

The setup.py and setup. cfg are the default packaging tools within PyPI, setuptools, pip, and the standard python library. Here, they represent the configuration and build scripts for setuptools. They both tell the setuptools how the package can be built and installed.

What is PyPI format?

PyPI primarily hosts Python packages in the form of archives called sdists (source distributions) or precompiled "wheels." PyPI as an index allows users to search for packages by keywords or by filters against their metadata, such as free software license or compatibility with POSIX.


1 Answers

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.

like image 116
pyfunc Avatar answered Oct 10 '22 00:10

pyfunc