From f674bf239e6ced4f420bee0a642053f63dace28b Mon Sep 17 00:00:00 2001 From: Max Wittig Date: Mon, 8 Jun 2020 17:23:19 +0200 Subject: [PATCH] chore: correctly render rst --- .travis.yml | 8 ++++++++ README.rst | 5 +++-- setup.py | 1 + tox.ini | 10 +++++++++- 4 files changed, 21 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index d4480a8f1..8170babe7 100644 --- a/.travis.yml +++ b/.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 diff --git a/README.rst b/README.rst index d8a035804..c98ff31f6 100644 --- a/README.rst +++ b/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`_. An example for new tests can be found in -tests/objects/test_runner.py +using `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: diff --git a/setup.py b/setup.py index 6b5737300..962608321 100644 --- a/setup.py +++ b/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", diff --git a/tox.ini b/tox.ini index 27988cb3f..df7ca090f 100644 --- a/tox.ini +++ b/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}