ci: deploy shpinx doc to gh-pages

.github/workflows/documentation.yml

@@ -0,0 +1,38 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+            python-version: 3.12
+
+      - name: Install dependencies
+        run: |
+            python -m pip install --upgrade pip
+            pip install -e .[dev,docs]
+            # stop the build if there are Python syntax errors or undefined names
+            ruff check . --select=E9,F63,F7,F82
+            pytest      
+
+      - name: Sphinx build
+        run: |
+            sphinx-build docs/source/ docs/build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/devel' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/
+          force_orphan: true

docs/source/index.rst

@@ -22,15 +22,9 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
-   quickstart
-   datamodel
-   concepts
-   schema
    api
-   cli
-   releasenotes
-   genindex
    Glossary
+
 * :ref:`genindex`
 * :ref:`Glossary`