@@ -21,13 +21,34 @@ Documentation
2121Apart from this overview, the following information is available:
2222- usage documentation for the [ latest release] ( https://pytest-dev.github.io/pytest-order/stable/ )
2323- usage documentation for the [ current main branch] ( https://pytest-dev.github.io/pytest-order/dev/ )
24- - all examples shown in the documentation can also be found in the
24+ - most examples shown in the documentation can also be found in the
2525 [ repository] ( https://github.com/pytest-dev/pytest-order/tree/main/example )
2626- the [ Release Notes] ( https://github.com/pytest-dev/pytest-order/blob/main/CHANGELOG.md )
2727 with a list of changes in the latest versions
2828- a [ list of open issues] ( https://github.com/pytest-dev/pytest-order/blob/main/old_issues.md )
2929 in the original project and their handling in ` pytest-order `
3030
31+ Features
32+ --------
33+ ` pytest-order ` provides the following features:
34+ - ordering of tests [ by index] ( https://pytest-dev.github.io/pytest-order/stable/usage.html#ordering-by-numbers )
35+ - ordering of tests both from the start and from the end (via negative
36+ index)
37+ - ordering of tests [ relative to each other] ( https://pytest-dev.github.io/pytest-order/stable/usage.html#order-relative-to-other-tests )
38+ (via the ` before ` and ` after ` marker attributes)
39+ - session-, module- and class-scope ordering via the
40+ [ order-scope] ( https://pytest-dev.github.io/pytest-order/stable/configuration.html#order-scope ) option
41+ - directory scope ordering via the
42+ [ order-scope-level] ( https://pytest-dev.github.io/pytest-order/stable/configuration.html#order-scope-level ) option
43+ - hierarchical module and class-level ordering via the
44+ [ order-group-scope] ( https://pytest-dev.github.io/pytest-order/stable/configuration.html#order-group-scope ) option
45+ - ordering tests with ` pytest-dependency ` markers if using the
46+ [ order-dependencies] ( https://pytest-dev.github.io/pytest-order/stable/configuration.html#order-dependencies ) option,
47+ more information about ` pytest-dependency ` compatibility
48+ [ here] ( https://pytest-dev.github.io/pytest-order/stable/other_plugins.html#relationship-with-pytest-dependency )
49+ - sparse ordering of tests via the
50+ [ sparse-ordering] ( https://pytest-dev.github.io/pytest-order/stable/configuration.html#sparse-ordering ) option
51+
3152Overview
3253--------
3354_ (adapted from the original project)_
@@ -70,25 +91,6 @@ yields the output:
7091
7192 =========================== 2 passed in 0.01 seconds ===========================
7293
73- Features
74- --------
75- ` pytest-order ` provides the following features:
76- - ordering of tests by index, as shown above
77- - ordering of tests both from the start and from the end (via negative
78- index)
79- - ordering of tests relative to each other (via the ` before ` and ` after `
80- marker attributes)
81- - session-, module- and class-scope ordering via the `` order-scope `` option
82- - directory scope ordering via the `` order-scope-level `` option
83- - hierarchical module and class-level ordering via the `` group-order-scope ``
84- option
85- - ordering tests with ` pytest-dependency ` markers if using the
86- `` order-dependencies `` option
87- - sparse ordering of tests via the `` sparse-ordering `` option
88-
89- A usage guide for each feature can be
90- found in the [ documentation] ( https://pytest-dev.github.io/pytest-order/dev/ ) .
91-
9294Contributing
9395------------
9496Contributions are very welcome. Tests can be run with
0 commit comments