Skip to content

Commit 9fa6b7b

Browse files
committed
Split documentation in dev and stable versions
- added incompatibility note - release for renamed package - split documentation in dev and stable versions
1 parent 3126e84 commit 9fa6b7b

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

CHANGELOG.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22

33
## Unreleased
44

5+
## [Version 0.7.1](https://pypi.org/project/pytest-order/0.7.1/)
6+
Update after renaming the repository and the package.
7+
58
### Changes
9+
- renamed repository and package from ``pytest-orderin2`` to ``pytest-order``
610
- changed the used marker from ``run`` to ``order``, removed all additional
711
markers (see [#38](https://github.com/ftobia/pytest-ordering/issues/38))
8-
- renamed repository and package from ``pytest-orderin2`` to ``pytest-order``
12+
13+
### Documentation
14+
- use separate documentation pages for release and development versions
915

1016
## [Version 0.7.0](https://pypi.org/project/pytest-ordering2/0.7.0/)
1117
Imported version from [pytest-ordering](https://github.com/ftobia/pytest-ordering),

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
pytest-order [![PyPI version](https://badge.fury.io/py/pytest-ordering2.svg)](https://badge.fury.io/py/pytest-ordering2)
1+
pytest-order [![PyPI version](https://badge.fury.io/py/pytest-order.svg)](https://badge.fury.io/py/pytest-order)
22
================
33
This is a fork of [pytest-ordering](https://github.com/ftobia/pytest-ordering).
44
That project is not maintained anymore, and there are several helpful PRs
@@ -9,6 +9,9 @@ organization as outlined in
99
[this issue](https://github.com/ftobia/pytest-ordering/issues/32). When this
1010
happens, this fork will be obsolete.
1111

12+
_Note:_ ``pytest-order`` is not compatible to ``pytest-ordering`` due to the
13+
changed marker name (``order`` instead of ``run``).
14+
1215

1316
pytest-order is a pytest plugin to run your tests in a specific order.
1417

@@ -43,12 +46,15 @@ Yields this output:
4346
$ py.test test_foo.py -vv
4447
============================= test session starts ==============================
4548
platform darwin -- Python 2.7.5 -- py-1.4.20 -- pytest-2.5.2 -- env/bin/python
46-
plugins: ordering
49+
plugins: order
4750
collected 2 items
4851

4952
test_foo.py:7: test_bar PASSED
5053
test_foo.py:3: test_foo PASSED
5154

5255
=========================== 2 passed in 0.01 seconds ===========================
5356

54-
You can find more information in the [documentation](https://mrbean-bremen.github.io/pytest-order/).
57+
More information can be found in the documentation:
58+
- for the [latest release](https://mrbean-bremen.github.io/pytest-order/stable/)
59+
- for the [current master](https://mrbean-bremen.github.io/pytest-order/dev/)
60+

0 commit comments

Comments
 (0)