Issue #1081: Fix PyPI Readme Rendering #1086
Merged
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
Scaling of these images is not supported by the readme_renderer used by the PyPI. See pypa/twine#1102 and pypa/readme_renderer#304.
text/x-rst for rst documents.
|
Great! Thanks for the changes :) |
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.
The readme renderer refuses to render scaled images (in this particular case, badges), as a result the skorch PyPi page is displayed as plain text. This is easily fixed by removing scaling from badges in the README. On top of that, Explicitly specifying RST content type for the long description solves a warning during rendering.
See #1081 for more info.