Configure for readthedocs (#284)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: Docs
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 12 * * 0'  # run once a week on Sunday
+  # Allows running this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  FORCE_COLOR: 1
+
+jobs:
+  tests:
+    name: Docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key:
+            docs-v1-${{ hashFiles('**/pyproject.toml') }}
+          restore-keys: |
+            docs-v1-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip tox
+
+      - name: Docs
+        run: |
+          tox -e docs

.github/workflows/lint.yml

@@ -23,7 +23,7 @@ jobs:
             ~/.cache/pip
             ~/.cache/pre-commit
           key:
-            lint-v1-${{ hashFiles('**/setup.py') }}-${{ hashFiles('**/.pre-commit-config.yaml') }}
+            lint-v1-${{ hashFiles('**/pyproject.toml') }}-${{ hashFiles('**/.pre-commit-config.yaml') }}
           restore-keys: |
             lint-v1-
 

.github/workflows/test.yml

@@ -53,7 +53,7 @@ jobs:
         with:
           path: ${{ steps.pip-cache.outputs.dir }}
           key:
-            ${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.pytest-version }}-v1-${{ hashFiles('**/setup.py') }}
+            ${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.pytest-version }}-v1-${{ hashFiles('**/pyproject.toml') }}
           restore-keys: |
             ${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.pytest-version }}-v1-
 

.readthedocs.yaml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "3"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt
+  - method: pip
+    path: .

README.rst

@@ -17,6 +17,9 @@ re-runs tests to eliminate intermittent failures.
 .. image:: https://github.com/pytest-dev/pytest-rerunfailures/workflows/Test/badge.svg
    :target: https://github.com/pytest-dev/pytest-rerunfailures/actions
    :alt: GitHub Actions
+.. image:: https://readthedocs.org/projects/pytest-rerunfailures/badge/?version=latest
+    :target: https://pytest-rerunfailures.readthedocs.io/latest/?badge=latest
+    :alt: Documentation Status
 
 .. START-INSTALLATION
 

docs/requirements.txt

@@ -0,0 +1,2 @@
+Sphinx
+sphinx_rtd_theme

tox.ini

@@ -12,6 +12,7 @@ max-line-length = 88
 envlist =
     linting
     py{39,310,311,312,313,py3}-pytest{74,80,81,82,83,main}
+    docs
 minversion = 4.0
 
 [testenv]
@@ -30,3 +31,10 @@ basepython = python3
 commands = pre-commit run --all-files --show-diff-on-failure {posargs:}
 deps = pre-commit>=1.11.0
 skip_install = True
+
+[testenv:docs]
+basepython = python3
+skip_install = True
+deps = -r docs/requirements.txt
+commands =
+    sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html