Skip to content

Commit f674bf2

Browse files
committed
chore: correctly render rst
1 parent 01ff865 commit f674bf2

File tree

4 files changed

+21
-3
lines changed

4 files changed

+21
-3
lines changed

.travis.yml

+8
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,14 @@ jobs:
8383
script:
8484
- pip3 install tox
8585
- tox -e py38
86+
- stage: test
87+
dist: bionic
88+
name: twine-check
89+
python: 3.8
90+
script:
91+
- pip3 install tox wheel
92+
- python3 setup.py sdist bdist_wheel
93+
- tox -e twine-check
8694
- stage: test
8795
dist: bionic
8896
name: coverage

README.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,9 @@ passing tests are mandatory to get merge requests accepted.
130130

131131
We're currently in a restructing phase for the unit tests. If you're changing existing
132132
tests, feel free to keep the current format. Otherwise please write new tests with pytest and
133-
using `responses<https://github.com/getsentry/responses>`_. An example for new tests can be found in
134-
tests/objects/test_runner.py
133+
using `responses
134+
<https://github.com/getsentry/responses/>`_.
135+
An example for new tests can be found in tests/objects/test_runner.py
135136

136137
You need to install ``tox`` to run unit tests and documentation builds locally:
137138

setup.py

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ def get_version():
2020
version=get_version(),
2121
description="Interact with GitLab API",
2222
long_description=readme,
23+
long_description_content_type="text/x-rst",
2324
author="Gauvain Pocentek",
2425
author_email="gauvain@pocentek.net",
2526
license="LGPLv3",

tox.ini

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[tox]
22
minversion = 1.6
33
skipsdist = True
4-
envlist = py38,py37,py36,pep8,black
4+
envlist = py38,py37,py36,pep8,black,twine-check
55

66
[testenv]
77
passenv = GITLAB_IMAGE GITLAB_TAG
@@ -27,6 +27,14 @@ deps = -r{toxinidir}/requirements.txt
2727
commands =
2828
black {posargs} gitlab tools/functional
2929

30+
[testenv:twine-check]
31+
basepython = python3
32+
deps = -r{toxinidir}/requirements.txt
33+
-r{toxinidir}/test-requirements.txt
34+
twine
35+
commands =
36+
twine check dist/*
37+
3038
[testenv:venv]
3139
commands = {posargs}
3240

0 commit comments

Comments
 (0)