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.

Sign up for GitHub

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

Jump to bottom

Use long_description from README.md #73

Closed
wants to merge 1 commit into from
Closed

Use long_description from README.md #73

wants to merge 1 commit into from

Conversation

senpos
Copy link
Contributor

@senpos senpos commented Jul 11, 2018

Closes #72

This change will make it easier to maintain README for both PyPI and repo, because actual text will come from a single place.

This idea comes from the official packaging tutorial.

Probably, nothing else should be done to make this work.

@joshuaskelly
Copy link
Owner

I noticed that the long description in setup.py doesn't include the Contributors section, but the README does. Will this render correctly on PyPi?

@senpos
Copy link
Contributor Author

senpos commented Jul 11, 2018

@joshuaskelly
I believe so.

Check out this article, which claims that PyPI now supports GitHub-flavored Markdown since April 2018.
Also, here is a discussion about it.

@joshuaskelly joshuaskelly self-requested a review July 11, 2018 18:10
@PythooonUser
Copy link
Collaborator

I wish Sphinx would support GFM, too...

@senpos
Copy link
Contributor Author

senpos commented Jul 11, 2018 •
edited
Loading

@PythooonUser
Have you ever seen GitBook? :)
They promise so many cool things ✨

@PythooonUser
Copy link
Collaborator

Oh, that looks nice!

joshuaskelly
joshuaskelly approved these changes Jul 12, 2018
View reviewed changes
Copy link
Owner

@joshuaskelly joshuaskelly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 👍

@PythooonUser PythooonUser self-requested a review August 3, 2018 18:01
PythooonUser
PythooonUser approved these changes Aug 3, 2018
View reviewed changes
Copy link
Collaborator

@PythooonUser PythooonUser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Feel free to merge at your earliest convenience.

@senpos senpos closed this Dec 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PythooonUser PythooonUser PythooonUser approved these changes

@joshuaskelly joshuaskelly joshuaskelly approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use README.md in setup.py -> long_description
3 participants
@senpos @joshuaskelly @PythooonUser