Add example files for all examples in documentation

Author: mrbean-bremen

README.md

@@ -20,6 +20,8 @@ Documentation
 Apart from this overview, the following information is available:
 - usage documentation for the [latest release](https://mrbean-bremen.github.io/pytest-order/stable/)
 - usage documentation for the [current master](https://mrbean-bremen.github.io/pytest-order/dev/)
+- all examples shown in the documentation can also be found in the 
+  [repository](https://github.com/mrbean-bremen/pytest-order/tree/master/example)
 - the [Release Notes](https://github.com/mrbean-bremen/pytest-order/blob/master/CHANGELOG.md)
   with a list of changes in the latest versions
 - a [list of open issues](https://github.com/mrbean-bremen/pytest-order/blob/master/old_issues.md)

docs/source/index.rst

@@ -60,6 +60,12 @@ The latest master can be installed from the GitHub sources:
 
    pip install git+https://github.com/mrbean-bremen/pytest-order
 
+Examples
+--------
+All examples shown in this documentation can be also found in the repository
+under `example <https://github.com/mrbean-bremen/pytest-order/tree/master/example/>`__
+as working test files.
+
 Quickstart
 ----------
 Ordinarily pytest will run tests in the order that they appear in a module.
@@ -301,14 +307,14 @@ with a ``::`` suffix has to be prepended to the test name:
 
  class TestA:
      @pytest.mark.order(after="TestB::test_c")
-     def test_a():
+     def test_a(self):
          assert True
 
-     def test_b():
+     def test_b(self):
          assert True
 
  class TestB:
-     def test_c():
+     def test_c(self):
          assert True
 
 If the referenced test lives in another module, the test name has to be
@@ -324,7 +330,7 @@ the following module and test layout:
   test_module_b.py
       test_a
       test_b
-  test_module_c.py
+  test_module_c
       test_submodule.py
           test_1
           test_2

example/__init__.py

@@ -1,3 +1,8 @@
+"""Reference test without ordering from the quick start chapter.
+See https://mrbean-bremen.github.io/pytest-order/dev/#quickstart
+"""
+
+
 def test_foo():
     assert True
 

example/test.py

@@ -0,0 +1,18 @@
+"""Shows how to use relative sorting in test classes, see
+See https://mrbean-bremen.github.io/pytest-order/dev/#referencing-of-tests-in-other-classes-or-modules  # noqa: E501
+"""
+import pytest
+
+
+class TestA:
+    @pytest.mark.order(after="TestB::test_c")
+    def test_a(self):
+        assert True
+
+    def test_b(self):
+        assert True
+
+
+class TestB:
+    def test_c(self):
+        assert True

example/test_classes.py

@@ -0,0 +1,14 @@
+"""Shows how combined ordinal and relative sorting is handled.
+See https://mrbean-bremen.github.io/pytest-order/dev/#combination-of-absolute-and-relative-ordering  # noqa: E501
+"""
+import pytest
+
+
+@pytest.mark.order(index=0, after="test_second")
+def test_first():
+    assert True
+
+
+@pytest.mark.order(1)
+def test_second():
+    assert True

example/test_combined.py

@@ -0,0 +1,14 @@
+"""One of the test files showing the use of the --order-scope option.
+See https://mrbean-bremen.github.io/pytest-order/dev/#order-scope
+"""
+import pytest
+
+
+@pytest.mark.order(2)
+def test2():
+    pass
+
+
+@pytest.mark.order(1)
+def test1():
+    pass

example/test_module1.py

@@ -0,0 +1,14 @@
+"""One of the test files showing the use of the --order-scope option.
+See https://mrbean-bremen.github.io/pytest-order/dev/#order-scope
+"""
+import pytest
+
+
+@pytest.mark.order(2)
+def test2():
+    pass
+
+
+@pytest.mark.order(1)
+def test1():
+    pass

example/test_module2.py

@@ -0,0 +1,11 @@
+"""One of the example files showing relative ordering between modules.
+See https://mrbean-bremen.github.io/pytest-order/dev/#referencing-of-tests-in-other-classes-or-modules  # noqa: E501
+"""
+
+
+class TestA:
+    def test_a(self):
+        assert True
+
+    def test_b(self):
+        assert True