Move sphinx-specific :doc: entry out of README.rst #301
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.
On all the releases to date, including 0.6.8, the README is treated as plain text on PyPI:
https://pypi.org/project/PyVCF/0.6.8/
This is likely because it fails validation as a standalone RST file due to a Sphinx specific extension,
This fragment also renders poorly on GitHub, showing a blue clickable but non-functional link with text:
This pull request ensures that
README.rst
is a valid standalone RST file and will render cleanly on GitHub and hopefully also PyPI, while preserving the link when used as part of the main documentation's introduction.