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 does not support Markdown #309

Open
davehunt opened this issue Aug 10, 2015 · 2 comments
Open

PyPI description does not support Markdown #309

davehunt opened this issue Aug 10, 2015 · 2 comments

Comments

@davehunt
Copy link
Member

The package description on PyPI doesn't look good. This is because we're using Markdown, and PyPI does not support this. If we switch to ReStructuredText the formatting would be preserved between GitHub and PyPI.

@whimboo
Copy link
Contributor

whimboo commented Aug 13, 2015

Hm, I was playing directly around with it on the Github wiki by selecting reStructuredText as edit mode. But when I select Preview it still renders with unresolved references? Is there anything we will have to obey when we do that change?

Here my example:

Mozdownload_ is a Python package_ which handles downloading of Mozilla applications.

.. _Mozdownload: https://github.com/mozilla/mozdownload
.. _Python package: http://pypi.python.org/pypi/mozdownload

@davehunt
Copy link
Member Author

I'm not sure about the GitHub wiki, but that's not what this issue is about. See pytest-html README as an example rst file that works well in PyPI beyond that, I would have to search for the answers to any formatting questions myself.

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

No branches or pull requests

2 participants