search

rivermont / spidy

The simple, easy to use command line web crawler.
GNU General Public License v3.0
340 stars 69 forks source link

PyPI Description Formatting #43

Open rivermont opened 7 years ago

rivermont commented 7 years ago

After multiple tries I have yet to get PyPI to format the README correctly. Current state can be viewed here.

At the moment, I followed this SO answer and convert README.md to ReStructuredText when running setup.py. However it looks like you cannot have relative links on a PyPI page, so I changed them all to https links to the GitHub files.

It's still displaying the RST as text and not rendering it, but I don't know where to go from here.

iblancasa commented 7 years ago

You can have only a README.rst file in your repository. GitHub and PyPi will show it properly.

You can convert from MD to RST online: https://pandoc.org/try/