bcgsc / mavis

Merging, Annotation, Validation, and Illustration of Structural variants
http://mavis.bcgsc.ca
GNU General Public License v3.0
72 stars 14 forks source link

Fix PyPI rst #182

Closed creisle closed 5 years ago

creisle commented 5 years ago

MAVIS version: 2.2.2

Python version: 3.7

OS: centos07

Docs are not rendered properly on PyPi https://pypi.org/project/mavis/

Looks like there's a way for us to debug this using twine

twine check dist/*
Checking distribution dist/mavis-2.2.2-py2.py3-none-any.whl: warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.
Failed
The project's long_description has invalid markup which will not be rendered on PyPI. The following syntax errors were detected:
line 24: Warning: raw (and derived) roles disabled
Checking distribution dist/mavis-2.2.2-py3.7.egg: warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.
Failed
The project's long_description has invalid markup which will not be rendered on PyPI. The following syntax errors were detected:
line 24: Warning: raw (and derived) roles disabled
line 24: Warning: raw (and derived) roles disabled
Checking distribution dist/mavis-2.2.2.tar.gz: warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.
Failed
The project's long_description has invalid markup which will not be rendered on PyPI. The following syntax errors were detected:
line 24: Warning: raw (and derived) roles disabled
line 24: Warning: raw (and derived) roles disabled
line 24: Warning: raw (and derived) roles disabled
calchoo commented 5 years ago

Fixed

twine check dist/*
Checking distribution dist/mavis-2.2.3-py2.py3-none-any.whl: Passed
Checking distribution dist/mavis-2.2.3-py3.6.egg: Passed
Checking distribution dist/mavis-2.2.3.tar.gz: Passed