Merge pull request #2536 from VWS-Python/docs-github-pages-4

Switch from ReadTheDocs to GitHub Pages

Author: adamtheturtle

.github/workflows/publish-site.yml

@@ -0,0 +1,27 @@
+---
+name: Deploy documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    environment:
+      name: ${{ github.ref_name == 'main' && 'github-pages' || 'development' }}
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - id: deployment
+        uses: sphinx-notes/pages@v3
+        with:
+          documentation_path: docs/source
+          pyproject_extras: dev
+          python_version: '3.13'
+          sphinx_build_options: -W
+          publish: ${{ github.ref_name == 'main' }}

README.rst

@@ -1,4 +1,4 @@
-|Build Status| |codecov| |PyPI| |Documentation Status|
+|Build Status| |codecov| |PyPI|
 
 VWS Mock
 ========
@@ -45,12 +45,12 @@ It is possible run a Mock VWS instance using Docker containers.
 
 This allows you to run tests against a mock VWS instance regardless of the language or tooling you are using.
 
-See the `the instructions <https://vws-python-mock.readthedocs.io/en/latest/docker.html>`__ for how to do this.
+See the `the instructions <https://vws-python.github.io/vws-python-mock/docker.html>`__ for how to do this.
 
 Full documentation
 ------------------
 
-See the `full documentation <https://vws-python-mock.readthedocs.io/en/latest>`__.
+See the `full documentation <https://vws-python.github.io/vws-python-mock/>`__.
 This includes details on how to use the mock, options, and details of the differences between the mock and the real Vuforia Web Services.
 
 
@@ -60,7 +60,4 @@ This includes details on how to use the mock, options, and details of the differ
    :target: https://codecov.io/gh/VWS-Python/vws-python-mock
 .. |PyPI| image:: https://badge.fury.io/py/VWS-Python-Mock.svg
     :target: https://badge.fury.io/py/VWS-Python-Mock
-.. |Documentation Status| image:: https://readthedocs.org/projects/vws-python-mock/badge/?version=latest
-   :target: https://vws-python-mock.readthedocs.io/en/latest/?badge=latest
-   :alt: Documentation Status
 .. |minimum-python-version| replace:: 3.13

pyproject.toml

@@ -109,7 +109,7 @@ optional-dependencies.dev = [
     "yamlfix==1.17.0",
 ]
 optional-dependencies.release = [ "check-wheel-contents==0.6.1" ]
-urls.Documentation = "https://vws-python-mock.readthedocs.io"
+urls.Documentation = "https://vws-python.github.io/vws-python-mock/"
 urls.Source = "https://github.com/VWS-Python/vws-python-mock"
 
 [tool.setuptools]
@@ -314,7 +314,7 @@ ignore = [
     ".yamlfmt",
     "*.enc",
     "admin/**",
-    "readthedocs.yaml",
+
     "CHANGELOG.rst",
     "CODE_OF_CONDUCT.rst",
     "CONTRIBUTING.rst",