This repository was archived by the owner on Mar 25, 2024. It is now read-only.
Switch to reStructuredText README #11
Merged
Conversation
This file contains hidden or 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
PyPI doesn't render markdown, it parses README.md assuming reST rules: pypi/legacy#148 which currently causes joined lines on https://pypi.python.org/pypi/manageiq-api-client-python/ Using README.rst with reST syntax is the simplest workaround.
|
cc @dkorn |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PyPI doesn't render markdown, it parses README.md assuming reST rules:
pypi/legacy#148
(after 2 years and several attempts, there's still no agreement on right fix)
This currently causes joined lines on
https://pypi.python.org/pypi/manageiq-api-client-python/
There are some workarounds to get README.md working using automatic
translation, but just simplest is just switching to README.rst with reST syntax.
(especially since in this case it's just a couple chars difference)
Rendered README.rst: https://github.com/cben/manageiq-api-client-python/blob/4bedcb08103b56b659218e70344a3ea146b23ef7/README.rst