Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Mention not using Sphinx extensions in "Making a PyPI-friendly README" #562
I thought I was doing the right thing by including Sphinx cross-references
The error message from
(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.)
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.