Merge pull request #1112 from python-gitlab/fix/rst-renderer

chore: correctly render rst

.travis.yml

@@ -83,6 +83,14 @@ jobs:
       script:
         - pip3 install tox
         - tox -e py38
+    - stage: test
+      dist: bionic
+      name: twine-check
+      python: 3.8
+      script:
+        - pip3 install tox wheel
+        - python3 setup.py sdist bdist_wheel
+        - tox -e twine-check
     - stage: test
       dist: bionic
       name: coverage

README.rst

@@ -130,8 +130,9 @@ passing tests are mandatory to get merge requests accepted.
 
 We're currently in a restructing phase for the unit tests. If you're changing existing
 tests, feel free to keep the current format. Otherwise please write new tests with pytest and
-using `responses<https://github.com/getsentry/responses>`_. An example for new tests can be found in
-tests/objects/test_runner.py
+using `responses
+<https://github.com/getsentry/responses/>`_.
+An example for new tests can be found in tests/objects/test_runner.py
 
 You need to install ``tox`` to run unit tests and documentation builds locally:
 

setup.py

@@ -20,6 +20,7 @@ def get_version():
     version=get_version(),
     description="Interact with GitLab API",
     long_description=readme,
+    long_description_content_type="text/x-rst",
     author="Gauvain Pocentek",
     author_email="gauvain@pocentek.net",
     license="LGPLv3",

tox.ini

@@ -1,7 +1,7 @@
 [tox]
 minversion = 1.6
 skipsdist = True
-envlist = py38,py37,py36,pep8,black
+envlist = py38,py37,py36,pep8,black,twine-check
 
 [testenv]
 passenv = GITLAB_IMAGE GITLAB_TAG
@@ -27,6 +27,14 @@ deps = -r{toxinidir}/requirements.txt
 commands =
   black {posargs} gitlab tools/functional
 
+[testenv:twine-check]
+basepython = python3
+deps = -r{toxinidir}/requirements.txt
+       -r{toxinidir}/test-requirements.txt
+       twine
+commands =
+  twine check dist/*
+
 [testenv:venv]
 commands = {posargs}