Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python > #54158 > unrolled thread

How to display ReST properly on pypi?

Back to article view | Back to comp.lang.python

Contents

  How to display ReST properly on pypi? Michel Albert <exhuma@gmail.com> - 2013-09-14 02:08 -0700
    Re: How to display ReST properly on pypi? Chris “Kwpolska” Warrick <kwpolska@gmail.com> - 2013-09-14 11:53 +0200
      Re: How to display ReST properly on pypi? Michel Albert <exhuma@gmail.com> - 2013-09-14 03:02 -0700

#54158 — How to display ReST properly on pypi?

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?

[toc] | [next] | [standalone]

#54160

On Sat, Sep 14, 2013 at 11:08 AM, Michel Albert <exhuma@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@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@kwpolska-lin config_resolver-3.3.0]% echo $?
1
[kwpolska@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

[toc] | [prev] | [next] | [standalone]

#54161

Ah... I understand. Makes sense.

I was confused that it worked properly on github, but not on pypi, so I never even thought about checking it in rst2html. I thought I would need to specify somewhere manually that it was formatted as ReST instead of plain-text.

Thanks for the info.

On Saturday, 14 September 2013 11:53:12 UTC+2, Chris “Kwpolska” Warrick  wrote:
> On Sat, Sep 14, 2013 at 11:08 AM, Michel Albert 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@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@kwpolska-lin config_resolver-3.3.0]% echo $?
> 
> 1
> 
> [kwpolska@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

[toc] | [prev] | [standalone]

Back to top | Article view | comp.lang.python

csiph-web