search

pypa / readme_renderer

Safely render long_description/README files in Warehouse
Apache License 2.0
158 stars 89 forks source link

rst admonitions (warning, note, tip, ...) rendering #147

Closed paugier closed 5 years ago

paugier commented 5 years ago

What's the problem this feature will solve?

Admonitions (http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions) in README.rst does not appear correctly on PyPI.

For an example see the first warning admonition at the beginning of this README.rst : https://pypi.org/project/transonic/

Describe the solution you'd like

It would be great if admonitions were displayed correctly, similarly as on readthedocs, see the corresponding warning admonition in https://transonic.readthedocs.io

ewdurbin commented 5 years ago

I'm going to transfer this issue/feature request to the pypa/readme_render project which is responsible for this rendering.

di commented 5 years ago

Duplicate of #132.