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

Added long_description_content_type #457

Merged
merged 1 commit into from Mar 18, 2018

Conversation

Projects
None yet
3 participants
@9999years
Contributor

9999years commented Mar 18, 2018

With PEP 566, the long_description can be Markdown with the long_description_content_type arg. This adds documentation for it

There were also a couple cases where filenames were enclosed with quotes rather than as code; I've changed those to be code as well for consistency.

See also:

Note that this references the README.md added in pypa/sampleproject#66, which is not yet merged. Merging that will break the link here, and merging this will result in a broken link until that PR is merged. Not sure what the best route there is.

Added long_description_content_type
With [PEP
566](https://www.python.org/dev/peps/pep-0566/#description-content-type-optional), the `long_description` can be Markdown with the `long_description_content_type` arg. This adds documentation for it

There were also a couple cases where filenames were enclosed with quotes
rather than as code; I've changed those to be `code` as well for
consistency.

See also:

 * [Relevant section in PEP 566](https://www.python.org/dev/peps/pep-0566/#description-content-type-optional)
 * [The CommonMark specification](http://spec.commonmark.org)
 * [The Description-Content-Type field documentation in the Python
   packaging documentation](https://packaging.python.org/specifications/core-metadata/#description-content-type-optional)

@9999years 9999years referenced this pull request Mar 18, 2018

Closed

Add markdown support #869

@brainwane

Heads-up if you'd like to be particularly fancy with your Sphinx/rST markup here: the :file: syntax might be a cool choice here for, e.g., setup.py and setup.cfg. Using :file: makes it possible for this documentation to someday format filenames in some special way. Which I think is cool. (This is in no way a "you must do this" criticism.)

@theacodes

This comment has been minimized.

Member

theacodes commented Mar 18, 2018

@brainwane the :file: role is great, but the inline code role (via ``) is fine as well.

@theacodes theacodes merged commit e695953 into pypa:master Mar 18, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@theacodes

This comment has been minimized.

Member

theacodes commented Mar 18, 2018

Thanks, @9999years!

@9999years

This comment has been minimized.

Contributor

9999years commented Mar 18, 2018

Great! I’ll open another for the :file: role (I took the 10 minutes to run through the repo and change it everywhere).

@brainwane

This comment has been minimized.

Member

brainwane commented May 2, 2018

Thanks for this, @9999years! Any chance we'll see you at one of our sprints this year?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment