Move documentation from GitHub Pages to Read the Docs

mrbean-bremen · mrbean-bremen · commit c5f21e34103f · 2022-10-09T14:23:14.000+02:00
- deploy on publish, change PyPI key name to default
diff --git a/.github/workflows/builddocartifacts.yml b/.github/workflows/builddocartifacts.yml
diff --git a/.github/workflows/builddocs.yml b/.github/workflows/builddocs.yml
diff --git a/.github/workflows/pythontests.yml b/.github/workflows/pythontests.yml
@@ -76,52 +76,3 @@ jobs:
       with:
         env_vars: OS
         name: codecov-pytest-order
-
-  deploy:
-    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
-
-    runs-on: ubuntu-latest
-
-    needs: [linter, test]
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        path: main
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: "3.8"
-    - name: Install wheel
-      run: |
-        python -m pip install --upgrade pip
-        pip install wheel
-    - name: Build package
-      run: |
-        cd main
-        python setup.py sdist bdist_wheel
-    - name: Publish package to PyPI
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        packages_dir: main/dist/
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN_PYTEST_ORDER }}
-    - name: Create release docs
-      run: |
-        pip install sphinx
-        cd main/docs
-        make html
-    - name: Checkout gh-pages
-      uses: actions/checkout@v2
-      with:
-        ref: gh-pages
-        path: doc
-    - name: Copy and commit changes
-      run: |
-        cp -r main/docs/build/html/* doc/stable
-        cd doc
-        git config user.name "CI Build"
-        git config user.email "pytest_order@gmail.com"
-        git add stable/*
-        git commit -a -m "Release documentation"
-        git push
diff --git a/.github/workflows/release-deploy.yml b/.github/workflows/release-deploy.yml
@@ -0,0 +1,37 @@
+name: release-deploy
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+
+  deploy:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: [ '3.10' ]
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        path: main
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Build package
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install build
+        cd main
+        python -m build
+
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ### Infrastructure
 - added pytest 7.0 to CI tests
+- moved documentation to [Read the Docs](https://pytest-order.readthedocs.io)
 
 ## [Version 1.0.1](https://pypi.org/project/pytest-order/1.0.1/) (2022-01-09)
 Bugfix release.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 _pytest-order_ - a pytest plugin to order test execution
 ========================================================
 
-[![PyPI version](https://badge.fury.io/py/pytest-order.svg)](https://pypi.org/project/pytest-order) [![Testsuite](https://github.com/pytest-dev/pytest-order/workflows/Testsuite/badge.svg)](https://github.com/pytest-dev/pytest-order/actions?query=workflow%3ATestsuite) [![DocBuild](https://github.com/pytest-dev/pytest-order/workflows/DocBuild/badge.svg)](https://github.com/pytest-dev/pytest-order/actions?query=workflow%3ADocBuild) [![codecov](https://codecov.io/gh/pytest-dev/pytest-order/branch/main/graph/badge.svg?token=M9PHWZSHUU)](https://codecov.io/gh/pytest-dev/pytest-order) [![Python version](https://img.shields.io/pypi/pyversions/pytest-order.svg)](https://pypi.org/project/pytest-order)
+[![PyPI version](https://badge.fury.io/py/pytest-order.svg)](https://pypi.org/project/pytest-order) [![Testsuite](https://github.com/pytest-dev/pytest-order/workflows/Testsuite/badge.svg)](https://github.com/pytest-dev/pytest-order/actions?query=workflow%3ATestsuite) [![DocBuild](https://readthedocs.org/projects/pytest-pyfakefs/badge/?version=latest)](https://pytest-pyfakefs.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/gh/pytest-dev/pytest-order/branch/main/graph/badge.svg?token=M9PHWZSHUU)](https://codecov.io/gh/pytest-dev/pytest-order) [![Python version](https://img.shields.io/pypi/pyversions/pytest-order.svg)](https://pypi.org/project/pytest-order)
 
 `pytest-order` is a pytest plugin that allows you to customize the order in which
 your tests are run. It uses the marker `order` that defines when a specific
@@ -19,8 +19,8 @@ versions >= 5.0.0 for all versions except Python 3.10, and for pytest >=
 Documentation
 -------------
 Apart from this overview, the following information is available:
-- usage documentation for the [latest release](https://pytest-dev.github.io/pytest-order/stable/)
-- usage documentation for the [current main branch](https://pytest-dev.github.io/pytest-order/dev/)
+- usage documentation for the [latest release](https://pytest-order.readthedocs.io/en/stable/)
+- usage documentation for the [current main branch](https://pytest-order.readthedocs.io/en/latest/)
 - most examples shown in the documentation can also be found in the 
   [repository](https://github.com/pytest-dev/pytest-order/tree/main/example)
 - the [Release Notes](https://github.com/pytest-dev/pytest-order/blob/main/CHANGELOG.md)
@@ -31,23 +31,23 @@ Apart from this overview, the following information is available:
 Features
 --------
 `pytest-order` provides the following features:
-- ordering of tests [by index](https://pytest-dev.github.io/pytest-order/stable/usage.html#ordering-by-numbers)
+- ordering of tests [by index](https://pytest-order.readthedocs.io/en/stable/usage.html#ordering-by-numbers)
 - ordering of tests both from the start and from the end (via negative
   index)
-- ordering of tests [relative to each other](https://pytest-dev.github.io/pytest-order/stable/usage.html#order-relative-to-other-tests)
+- ordering of tests [relative to each other](https://pytest-order.readthedocs.io/en/stable/usage.html#order-relative-to-other-tests)
   (via the `before` and `after` marker attributes)
 - session-, module- and class-scope ordering via the
-  [order-scope](https://pytest-dev.github.io/pytest-order/stable/configuration.html#order-scope) option
+  [order-scope](https://pytest-order.readthedocs.io/en/stable/configuration.html#order-scope) option
 - directory scope ordering via the
-  [order-scope-level](https://pytest-dev.github.io/pytest-order/stable/configuration.html#order-scope-level) option
+  [order-scope-level](https://pytest-order.readthedocs.io/en/stable/configuration.html#order-scope-level) option
 - hierarchical module and class-level ordering via the 
-  [order-group-scope](https://pytest-dev.github.io/pytest-order/stable/configuration.html#order-group-scope) option
+  [order-group-scope](https://pytest-order.readthedocs.io/en/stable/configuration.html#order-group-scope) option
 - ordering tests with `pytest-dependency` markers if using the
-  [order-dependencies](https://pytest-dev.github.io/pytest-order/stable/configuration.html#order-dependencies) option, 
+  [order-dependencies](hhttps://pytest-order.readthedocs.io/en/stable/configuration.html#order-dependencies) option, 
   more information about `pytest-dependency` compatibility
-  [here](https://pytest-dev.github.io/pytest-order/stable/other_plugins.html#relationship-with-pytest-dependency) 
+  [here](https://pytest-order.readthedocs.io/en/stable/other_plugins.html#relationship-with-pytest-dependency) 
 - sparse ordering of tests via the 
-  [sparse-ordering](https://pytest-dev.github.io/pytest-order/stable/configuration.html#sparse-ordering) option
+  [sparse-ordering](https://pytest-order.readthedocs.io/en/stable/configuration.html#sparse-ordering) option
 
 Overview
 --------
diff --git a/example/test.py b/example/test.py
@@ -1,5 +1,5 @@
 """Reference test without ordering from the quick start chapter.
-See https://pytest-dev.github.io/pytest-order/dev/#quickstart
+See https://pytest-order.readthedocs.io/en/stable/#quickstart
 """
 
 
diff --git a/example/test_classes.py b/example/test_classes.py
@@ -1,5 +1,5 @@
 """Shows how to use relative sorting in test classes, see
-See https://pytest-dev.github.io/pytest-order/dev/#referencing-of-tests-in-other-classes-or-modules  # noqa: E501
+See https://pytest-order.readthedocs.io/en/stable/#referencing-of-tests-in-other-classes-or-modules  # noqa: E501
 """
 import pytest
 
diff --git a/example/test_combined.py b/example/test_combined.py
@@ -1,5 +1,5 @@
 """Shows how combined ordinal and relative sorting is handled.
-See https://pytest-dev.github.io/pytest-order/dev/#combination-of-absolute-and-relative-ordering  # noqa: E501
+See https://pytest-order.readthedocs.io/en/stable/#combination-of-absolute-and-relative-ordering  # noqa: E501
 """
 import pytest
 
diff --git a/example/test_module1.py b/example/test_module1.py
@@ -1,5 +1,5 @@
 """One of the test files showing the use of the --order-scope option.
-See https://pytest-dev.github.io/pytest-order/dev/#order-scope
+See https://pytest-order.readthedocs.io/en/stable/#order-scope
 """
 import pytest
 
diff --git a/example/test_module2.py b/example/test_module2.py
@@ -1,5 +1,5 @@
 """One of the test files showing the use of the --order-scope option.
-See https://pytest-dev.github.io/pytest-order/dev/#order-scope
+See https://pytest-order.readthedocs.io/en/stable/#order-scope
 """
 import pytest
 
diff --git a/example/test_module_a.py b/example/test_module_a.py
@@ -1,5 +1,5 @@
 """One of the example files showing relative ordering between modules.
-See https://pytest-dev.github.io/pytest-order/dev/#referencing-of-tests-in-other-classes-or-modules  # noqa: E501
+See https://pytest-order.readthedocs.io/en/stable/#referencing-of-tests-in-other-classes-or-modules  # noqa: E501
 """
 
 
diff --git a/example/test_module_c/test_submodule.py b/example/test_module_c/test_submodule.py
@@ -1,5 +1,5 @@
 """One of the example files showing relative ordering between modules.
-See https://pytest-dev.github.io/pytest-order/dev/#referencing-of-tests-in-other-classes-or-modules  # noqa: E501
+See https://pytest-order.readthedocs.io/en/stable/#referencing-of-tests-in-other-classes-or-modules  # noqa: E501
 """
 
 
diff --git a/example/test_modules_b.py b/example/test_modules_b.py
@@ -1,5 +1,5 @@
 """Example showing ordering relative to tests in other modules.
-See https://pytest-dev.github.io/pytest-order/dev/#referencing-of-tests-in-other-classes-or-modules  # noqa: E501
+See https://pytest-order.readthedocs.io/en/stable/#referencing-of-tests-in-other-classes-or-modules  # noqa: E501
 """
 import pytest
 
diff --git a/example/test_number.py b/example/test_number.py
@@ -1,6 +1,6 @@
 """Shows how to use both positive and negative numbers for sorting,
 and the use of the long form (index attribute) and short form (number only).
-See https://pytest-dev.github.io/pytest-order/dev/#order-by-index
+See https://pytest-order.readthedocs.io/en/stable/#order-by-index
 """
 import pytest
 
diff --git a/example/test_ordinals.py b/example/test_ordinals.py
@@ -1,5 +1,5 @@
 """Shows how to use ordinal names for sorting.
-See https://pytest-dev.github.io/pytest-order/dev/#order-using-ordinals
+See https://pytest-order.readthedocs.io/en/stable/#order-using-ordinals
 """
 import pytest
 
diff --git a/example/test_quickstart.py b/example/test_quickstart.py
@@ -1,5 +1,5 @@
 """Test with ordering (as opposed to test.py) from the quick start chapter.
-See https://pytest-dev.github.io/pytest-order/dev/#quickstart
+See https://pytest-order.readthedocs.io/en/stable/#quickstart
 """
 import pytest
 
diff --git a/example/test_relative.py b/example/test_relative.py
@@ -1,5 +1,5 @@
 """Shows how to sort tests relatively to each other, see
-https://pytest-dev.github.io/pytest-order/dev/#order-relative-to-other-tests
+https://pytest-order.readthedocs.io/en/stable/#order-relative-to-other-tests
 """
 import pytest
 
diff --git a/example/test_sort_breaks_dependency.py b/example/test_sort_breaks_dependency.py
@@ -1,6 +1,6 @@
 """Test showing that sorting is not done if it would break an existing
 dependency.
-See https://pytest-dev.github.io/pytest-order/dev/#order-dependencies
+See https://pytest-order.readthedocs.io/en/stable/#order-dependencies
 """
 import pytest
 
diff --git a/example/test_sort_dependency.py b/example/test_sort_dependency.py
@@ -1,5 +1,5 @@
 """Test showing the behavior of the --order-dependencies option.
-See https://pytest-dev.github.io/pytest-order/dev/#order-dependencies
+See https://pytest-order.readthedocs.io/en/stable/#order-dependencies
 """
 import pytest
 
diff --git a/example/test_sparse_ordering.py b/example/test_sparse_ordering.py
@@ -1,5 +1,5 @@
 """Test file showing the behavior of the --sparse-ordering option.
-See https://pytest-dev.github.io/pytest-order/dev/#sparse-ordering
+See https://pytest-order.readthedocs.io/en/stable/#sparse-ordering
 """
 import pytest
 
diff --git a/pytest_order/plugin.py b/pytest_order/plugin.py
@@ -18,7 +18,7 @@ def pytest_configure(config: Config) -> None:
 
     provided_by_pytest_order = (
         "Provided by pytest-order. "
-        "See also: https://pytest-dev.github.io/pytest-order/"
+        "See also: https://pytest-order.readthedocs.io/"
     )
 
     config_line = (
