Skip to content

Commit feb4359

Browse files
committed
Update README.rst
1 parent 81811e0 commit feb4359

File tree

1 file changed

+38
-17
lines changed

1 file changed

+38
-17
lines changed

README.rst

Lines changed: 38 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@
22
pytest-qt
33
=========
44

5-
pytest-qt is a `pytest <http://pytest.org>`_ plugin to allow
6-
programmers write tests for `PySide <https://pypi.python.org/pypi/PySide>`_ and
7-
`PyQt <http://www.riverbankcomputing.com/software/pyqt>`_ applications.
5+
pytest-qt is a `pytest`_ plugin to allow
6+
programmers write tests for `PySide`_ and
7+
`PyQt`_ applications.
88

99
The main usage is to use the `qtbot` fixture, responsible for handling `qApp`
1010
creation as needed and provides methods to simulate user interaction,
1111
like key presses and mouse clicks::
1212

13+
.. _PySide: https://pypi.python.org/pypi/PySide
14+
.. _PyQt: http://www.riverbankcomputing.com/software/pyqt
15+
.. _pytest: http://pytest.org
1316

1417
def test_hello(qtbot):
1518
widget = HelloWidget()
@@ -23,27 +26,45 @@ like key presses and mouse clicks::
2326

2427
This allows you to test and make sure your view layer is behaving the way you expect after each code change.
2528

26-
[![version](http://img.shields.io/pypi/v/pytest-qt.svg)](https://crate.io/packages/pytest-qt)
27-
[![downloads](http://img.shields.io/pypi/dm/pytest-qt.svg)](https://crate.io/packages/pytest-qt/)
28-
[![ci](http://img.shields.io/travis/nicoddemus/pytest-qt.svg)](https://travis-ci.org/nicoddemus/pytest-qt)
29+
|version| |downloads| |ci|
2930

30-
## Requirements ##
31+
.. |version| image:: http://img.shields.io/pypi/v/pytest-qt.svg
32+
:target: https://crate.io/packages/pytest-qt
33+
34+
.. |downloads| image:: http://img.shields.io/pypi/dm/pytest-qt.svg
35+
:target: https://crate.io/packages/pytest-qt
36+
37+
.. |ci| image:: http://img.shields.io/travis/nicoddemus/pytest-qt.svg
38+
:target: https://travis-ci.org/nicoddemus/pytest-qt
39+
40+
41+
Requirements
42+
------------
3143

3244
Python 2.6 or later, including Python 3+.
3345

34-
Works with either [PySide](https://pypi.python.org/pypi/PySide) or
35-
[PyQt](http://www.riverbankcomputing.com/software/pyqt), picking one that is available giving
36-
preference to `PySide` if both are installed (to force it to use `PyQt`, set
37-
the environment variable `PYTEST_QT_FORCE_PYQT=true`).
46+
Works with either PySide_ or
47+
PyQt_ picking whichever is available on the system, giving
48+
preference to ``PySide`` if both are installed (to force it to use ``PyQt``, set
49+
the environment variable ``PYTEST_QT_FORCE_PYQT=true``).
50+
51+
Documentation
52+
-------------
53+
54+
Full documentation and tutorial available at `Read the Docs`_.
55+
56+
.. _Read The Docs: https://pytest-qt.readthedocs.org/en/latest/
3857

39-
## Documentation ##
58+
Change Log
59+
----------
4060

41-
Full documentation and tutorial available at [Read the Docs](https://pytest-qt.readthedocs.org/en/latest/).
61+
Please consult the `releases page`.
4262

43-
## Change Log ##
63+
.. _releases page: https://github.com/nicoddemus/pytest-qt/releases
4464

45-
Please consult the [releases page](https://github.com/nicoddemus/pytest-qt/releases).
65+
Bugs/Requests
66+
-------------
4667

47-
## Bugs/Requests ##
68+
Please report any issues or feature requests in the `issue tracker`.
4869

49-
Please report any issues or feature requests in the [issue tracker](https://github.com/nicoddemus/pytest-qt/issues).
70+
.. _issue tracker: https://github.com/nicoddemus/pytest-qt/issues

0 commit comments

Comments
 (0)