How to display ReST properly on pypi?

Chris “Kwpolska” Warrick kwpolska at gmail.com
Sat Sep 14 05:53:12 EDT 2013


On Sat, Sep 14, 2013 at 11:08 AM, Michel Albert <exhuma at gmail.com> wrote:
> In general, I write my README files using the ReST syntax. But when I do, they don't show up formatted on pypi (see for example https://pypi.python.org/pypi/config_resolver/3.3.0).
>
> How do I get it to be formatted properly?
>
> Also, is there a way to specify that the "description" field in setup.py is formatted as ReST?
> --
> https://mail.python.org/mailman/listinfo/python-list

rst2html crashes with your file.  Also, `py:class` is Sphinx-only and
won’t work with the Cheeseshop and produce garbage in the output.

[kwpolska at kwpolska-lin config_resolver-3.3.0]% rst2html README.rst
README.rst:67: (WARNING/2) Inline emphasis start-string without end-string.
README.rst:108: (ERROR/3) Unknown interpreted text role "py:class".
README.rst:115: (ERROR/3) Unknown interpreted text role "py:class".
README.rst:121: (ERROR/3) Unknown interpreted text role "py:class".
README.rst:142: (SEVERE/4) Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'CHANGES'.
Exiting due to level-4 (SEVERE) system message.
[kwpolska at kwpolska-lin config_resolver-3.3.0]% echo $?
1
[kwpolska at kwpolska-lin config_resolver-3.3.0]%

-- 
Chris “Kwpolska” Warrick <http://kwpolska.tk>
PGP: 5EAAEA16
stop html mail | always bottom-post | only UTF-8 makes sense



More information about the Python-list mailing list