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.

Sign up for GitHub

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

Jump to bottom

pypi allows for markdown descriptions now, so pandoc isn't needed #26

Open

CamDavidsonPilon opened this issue Dec 17, 2018 · 0 comments

Contributor

CamDavidsonPilon commented Dec 17, 2018

In setup.py, there is

try:
    import pypandoc
    readme_rst = pypandoc.convert_file(readme_md, 'rst')
except(ImportError):
    readme_rst = open(readme_md).read()

that will convert the markdown readme to an rst file. This was because historically PyPI only allowed rst docs as descriptions. However, PyPI now allows md files: https://packaging.python.org/guides/making-a-pypi-friendly-readme/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment