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.

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

Move sphinx-specific :doc: entry out of README.rst #301

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

peterjc
Copy link

@peterjc peterjc commented Sep 21, 2018

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,

$ pip install restructuredtext-lint
...
$ restructuredtext-lint README.rst 
ERROR README.rst:179 Unknown interpreted text role "doc".

This fragment also renders poorly on GitHub, showing a blue clickable but non-functional link with text:

 :doc:`FILTERS`

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.

This ensures that README.rst is a valid standalone RST
file and will render cleanly on GitHub and hopefully
also PyPI.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant