docs: specify description type for pypi to render correctly #529
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While working on #528, I realized that the docs don't actually render correctly on PyPi. This is because PyPi defaults to assuming a
.rst
file ( as specified in the FAQs) and our readme is.md
PyPi pointed to the python packaging guide which explains to include the
long_description_content_type="text/markdown",
parameter in your setup for proper packaging. On testing withtwine
as specified in the python packaging guide, I got an errorUnexpected indentation line 270
which was fixed by unindenting the two lines below.Steps to test the docs are:
$ python setup.py sdist
$ twine check dist/*
Sorry for all the links but hope this makes sense!