docs: publish to GitHub Pages instead of ReadTheDocs

.github/workflows/docs.yml

@@ -0,0 +1,61 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: |
+            requirements.txt
+            docs/requirements.txt
+
+      - name: Install dependencies
+        # The package itself is not installed: docs/conf.py puts the repository
+        # root on sys.path, so autodoc imports xarray_video from the source tree.
+        # Only its runtime imports need to resolve.
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r docs/requirements.txt
+
+      - name: Build HTML docs
+        run: |
+          sphinx-build -b html docs docs/_build/html
+          touch docs/_build/html/.nojekyll
+
+      - name: Upload Pages artifact
+        if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    concurrency:
+      group: pages
+      cancel-in-progress: false
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -69,7 +69,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-#docs/_build/
+docs/_build/
 
 # PyBuilder
 target/

README.md

@@ -6,4 +6,4 @@ xarray accessor and zarr codec for working with video data.
 pip install xarray-video
 ```
 
-Documentation is at: https://xarray-video.readthedocs.io/
+Documentation is at: https://oceanum.github.io/xarray-video/

README.rst

@@ -5,8 +5,8 @@ Xarray extension for working with video data.
 
 
 * MIT license
-* Documentation: https://xarray-video.readthedocs.io.
-* Github: https://github.com/oceanum-io/xarray-video
+* Documentation: https://oceanum.github.io/xarray-video/
+* Github: https://github.com/oceanum/xarray-video
 
 
 Features