Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make README compliant with PyPI RST renderer #60

Merged
merged 1 commit into from
May 17, 2019
Merged

Conversation

tortila
Copy link
Contributor

@tortila tortila commented May 17, 2019

Signed-off-by: Oliwia Zaremba oliwia.zaremba@zalando.de

Recent release failed because of the following error:

[UploadError]                                                    
HTTP Error 400: The description failed to render for 'text/x-rst'. See https  
://pypi.org/help/#description-content-type for more information.   

By installing readme-renderer and following its hints, I made small changes to README.rst so that it's compliant with renderer on PyPI. I also added this check in .travis.yaml (part of make 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

  • Configuration change

Review

Reviewers' checklist:

  • If this PR implements new flows or changes existing ones, are there
    good tests for these flows?
    If this PR rather removes flows, are the obsolete tests removed as well?
  • Is the documentation still up-to-date and exhaustive? This covers both
    technical (in source files) and functional (under docs/) documentation.
  • Is the changelog updated?
  • Does the new version number correspond to the actual changes from this PR?
    In doubt, refer to https://semver.org.

After this PR

Check if release is successful, check how README renders on PyPI.

Signed-off-by: Oliwia Zaremba <oliwia.zaremba@zalando.de>
@tortila tortila requested review from bmaher and thilp as code owners May 17, 2019 16:27
@zincr
Copy link

zincr bot commented May 17, 2019

🤖 zincr found 0 problems , 0 warnings

✅ Large Commits
✅ Approvals
✅ Specification
✅ Dependency Licensing

@tortila
Copy link
Contributor Author

tortila commented May 17, 2019

FYI I thought it would be cool to have this supported by Poetry, so I created this feature request: python-poetry/poetry#1108

@thilp thilp merged commit fd56541 into master May 17, 2019
@thilp thilp deleted the fix-readme-rendering branch June 19, 2020 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants