docs: specify description type for pypi to render correctly #529
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nakulpathak3
force-pushed
the
specify-md-setup
branch
from
751e756
to
729a5e5
Compare
nakulpathak3
force-pushed
the
specify-md-setup
branch
from
729a5e5
to
ec565ed
Compare
nakulpathak3
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
.rstfile ( as specified in the FAQs) and our readme is.mdPyPi 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 withtwineas specified in the python packaging guide, I got an errorUnexpected indentation line 270which 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!