Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PyPI Description Formatting #43

Open
rivermont opened this issue Oct 7, 2017 · 1 comment
Open

PyPI Description Formatting #43

rivermont opened this issue Oct 7, 2017 · 1 comment
Labels

Comments

@rivermont
Copy link
Owner

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
Copy link

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/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants