Merge pull request #2553 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-python
 ==========
@@ -67,15 +67,12 @@ Getting Started
 Full Documentation
 ------------------
 
-See the `full
-documentation <https://vws-python.readthedocs.io/en/latest>`__.
+See the `full documentation <https://vws-python.github.io/vws-python/>`__.
 
 .. |Build Status| image:: https://github.com/VWS-Python/vws-python/actions/workflows/ci.yml/badge.svg?branch=main
    :target: https://github.com/VWS-Python/vws-python/actions
 .. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-python/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/VWS-Python/vws-python
 .. |PyPI| image:: https://badge.fury.io/py/VWS-Python.svg
    :target: https://badge.fury.io/py/VWS-Python
-.. |Documentation Status| image:: https://readthedocs.org/projects/vws-python/badge/?version=latest
-   :target: https://vws-python.readthedocs.io/en/latest/?badge=latest
 .. |minimum-python-version| replace:: 3.12

docs/source/index.rst

@@ -114,7 +114,6 @@ See https://vws-python-mock.readthedocs.io/en/latest/differences-to-vws.html for
 
 .. _VWS Python Mock: https://github.com/VWS-Python/vws-python-mock
 
-
 Reference
 ---------
 

pyproject.toml

@@ -82,7 +82,7 @@ optional-dependencies.dev = [
     "yamlfix==1.17.0",
 ]
 optional-dependencies.release = [ "check-wheel-contents==0.6.1" ]
-urls.Documentation = "https://vws-python.readthedocs.io/en/latest/"
+urls.Documentation = "https://vws-python.github.io/vws-python/"
 urls.Source = "https://github.com/VWS-Python/vws-python"
 
 [tool.setuptools]
@@ -283,7 +283,6 @@ ignore = [
     ".yamlfmt",
     "*.enc",
     ".pre-commit-config.yaml",
-    "readthedocs.yaml",
     "CHANGELOG.rst",
     "CODE_OF_CONDUCT.rst",
     "CONTRIBUTING.rst",