search

openwisp / django-rest-framework-gis

Geographic add-ons for Django REST Framework. Maintained by the OpenWISP Project.
http://openwisp.org
MIT License
1.09k stars 201 forks source link

Fixed README invalid markup that cause PyPI to show the raw source. #183

Closed pauloxnet closed 5 years ago

pauloxnet commented 6 years ago

After last release the README is visible in on pypi.org but as raw code. https://pypi.org/project/djangorestframework-gis/

I checked the README.rst file and found this error:

$ python setup.py check -r -s
running check
warning: check: Error in "code-block" directive:
maximum 1 argument(s) allowed, 7 supplied. (line 663)
error: Please correct your package.

I fixed the README.rst and checked again to confirm it's validity.

For the next release could be useful check the package before submit it: https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup

pauloxnet commented 5 years ago

Hello @nemesisdesign I've tried to add the above check in travis build in the PR #184 and it seems to work.