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

Use README.rst as long description in setup.py #411

Merged
merged 2 commits into from Feb 20, 2019

Conversation

Projects
None yet
3 participants
@alubbock
Copy link
Member

commented Feb 4, 2019

No description provided.

@coveralls

This comment has been minimized.

Copy link

commented Feb 4, 2019

Coverage Status

Coverage remained the same at 79.295% when pulling 31fb67a on alubbock:readme_longdesc into 470945e on pysb:master.

1 similar comment
@coveralls

This comment has been minimized.

Copy link

commented Feb 4, 2019

Coverage Status

Coverage remained the same at 79.295% when pulling 31fb67a on alubbock:readme_longdesc into 470945e on pysb:master.

@jmuhlich
Copy link
Member

left a comment

From my reading of https://packaging.python.org/guides/making-a-pypi-friendly-readme/ I believe we need to set long_description_content_type='text/x-rst' too. We should validate the content with twine too (also covered in the docs at the above link), and maybe even add that step to the Travis build.

@alubbock alubbock force-pushed the alubbock:readme_longdesc branch from 31fb67a to 56d8af6 Feb 19, 2019

@alubbock

This comment has been minimized.

Copy link
Member Author

commented Feb 19, 2019

@jmuhlich Good idea, implemented as requested.

@alubbock alubbock merged commit d3af6f1 into pysb:master Feb 20, 2019

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@alubbock alubbock deleted the alubbock:readme_longdesc branch Feb 20, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.