Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

My rst README is not formatted on pypi.python.org

When I submit my package to the Python Package Index (https://pypi.python.org/pypi) my README file, which is written with valid reStructuredText and saved as README.rst, is displayed as plain text without any formatting.

I have run it through validators (rstctl and collective.checkdocs) and no errors are returned.

My package is at: https://pypi.python.org/pypi/lcinvestor

It's in github at: https://github.com/jgillick/LendingClubAutoInvestor

like image 349
Jeremy Gillick Avatar asked May 03 '13 21:05

Jeremy Gillick


People also ask

Does PyPI support markdown?

Formats supported by PyPI's README renderer are: plain text. reStructuredText (without Sphinx extensions) Markdown (GitHub Flavored Markdown by default, or CommonMark)

What is readme in Python?

README files can help your users understand your project and can be used to set your project's description on PyPI. This guide helps you create a README in a PyPI-friendly format and include your README in your package so it appears on PyPI.


Video Answer


1 Answers

It turns out that the answer from @sigmavirus regarding the links was close. I started a discussion on the distutils mailing list and found out that in-page links (i.e. #minimum-cash) are not allowed by the pypi reStructuredText parser and will invalidate the entire document.

It seems that pypi uses a whitelist to filter link protocols (http vs ftp vs gopher), and sees '#' as an invalid protocol. It seems like this would be pretty easy to fix on their end, but until then, I'll be removing my in-page anchor links.

like image 195
Jeremy Gillick Avatar answered Sep 26 '22 18:09

Jeremy Gillick