README.md looks bad on PyPI about toolz HOT 4 CLOSED

Github renders markdown natively. Does github support RST? If not then is
there a minimally offending subset that we can use?

On Mon, Nov 18, 2013 at 10:12 AM, Erik Welch [email protected]:

PyPI (and its cousins) expects reStructuredText for the long description
of a package. Markdown renders partially correctly, but much of it is
rendered incorrectly as can be seen here:
https://pypi.python.org/pypi/toolz
https://crate.io/packages/toolz/

"pandoc" can convert from markdown to rst, although a couple changes to
README.md may be required to convert everything smoothly. For example,
itertoolz,hasn't converted properly for me (maybe a newer version of pandoc or
different command line options would help), but changing itertools to
itertools works.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/104
.

from toolz.

Yes, github renders RST and all the other markups listed here: https://github.com/github/markup

For example, sympy, ipython, matplotlib, scikit-learn (and many others) all have a README.rst

from toolz.

Then moving to RST sounds like a good idea to me.

On Mon, Nov 18, 2013 at 10:34 AM, Erik Welch [email protected]:

Yes, github renders RST and all the other markups listed here:
https://github.com/github/markup

For example, sympy, ipython, matplotlib, scikit-learn (and many others)
all have a README.rst

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/104#issuecomment-28724616
.

from toolz.

I can do this tonight. I found a way to make literal text also a hyperlink in rst, such as itertoolz:

|literal itertoolz|_, for operations on iterables. Examples: ``groupby``, ``unique``, ``interpose``,

.. |literal itertoolz| replace:: ``itertoolz``
.. _literal itertoolz: https://github.com/pytoolz/toolz/blob/master/toolz/itertoolz/core.py

from toolz.