Mention not using Sphinx extensions in "Making a PyPI-friendly README" #562
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I thought I was doing the right thing by including [Sphinx cross-references](http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-python-objects) in my `README.rst` and through that in my package's `long_description`, but only after several failed validations and searching did I learn that Sphinx extensions are not allowed. The error message from `twine check` (or `rst-lint`) is not obvious about what is wrong: e.g., 'Error: Unknown interpreted text role "py:func".' and to those just figuring out Sphinx and rST the distinction is not necessarily obvious.
theacodes
approved these changes
Oct 5, 2018
|
Thanks, @wcooley! |
|
@wcooley please also note that the opposite might be useful: you can include parts of your readme into sphinx docs and it might be useful to add some markers in README, which won't be rendered :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I thought I was doing the right thing by including Sphinx cross-references
in my
README.rstand through that in my package'slong_description, but only afterseveral failed validations and searching did I learn that Sphinx extensions are not allowed.
The error message from
twine check(orrst-lint) is not obvious about what is wrong: e.g.,'Error: Unknown interpreted text role "py:func".' and to those just figuring out Sphinx and rST
the distinction is not necessarily obvious.
(I am submitting this PR against "master" because the other 2 open PRs do that; I read the contributing guide but it gave no advice about which branch to use.)