Make README compliant with PyPI RST renderer #60
Merged
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.
Signed-off-by: Oliwia Zaremba oliwia.zaremba@zalando.de
Recent release failed because of the following error:
By installing
readme-renderer
and following its hints, I made small changes toREADME.rst
so that it's compliant with renderer on PyPI. I also added this check in.travis.yaml
(part ofmake lint
now).Post-fix to #57 (well, this is where I found the issue, not where I introduced it)
Not bumping the version because the most recent releases failed.
Types of Changes
Review
Reviewers' checklist:
good tests for these flows?
If this PR rather removes flows, are the obsolete tests removed as well?
technical (in source files) and functional (under
docs/
) documentation.In doubt, refer to https://semver.org.
After this PR
Check if release is successful, check how README renders on PyPI.