Merge pull request #18 from predict-idlab/docs-migrate_pdoc

Docs: migrate to pdoc

Author: Epse

.github/workflows/pdoc.yml

@@ -0,0 +1,47 @@
+name: website
+
+# build the documentation whenever there are new commits on main
+on:
+  push:
+    branches:
+      - main
+    # Alternative: only build for tags.
+    # tags:
+    #   - '*'
+
+# security: restrict permissions for CI jobs.
+permissions:
+  contents: read
+
+jobs:
+  # Build the documentation and upload the static HTML files as an artifact.
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+      - run: uv run pdoc ./src/obelisk -o docs/ --math
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: docs/
+
+  # Deploy the artifact to GitHub pages.
+  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/sphinx-documentation.yml

@@ -26,6 +26,8 @@ share/python-wheels/
 *.egg
 MANIFEST
 
+.python-version
+
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
@@ -46,9 +48,7 @@ coverage.xml
 cover/
 
 # Sphinx documentation
-docs/_build/
-docs/build/
-docs/source/_autosummary/
+docs/
 
 # PyBuilder
 .pybuilder/

.gitignore

@@ -41,10 +41,10 @@ source = "vcs"
 
 [dependency-groups]
 dev = [
-    "sphinx>=7.4.7",
     "pytest>=8.3.5",
     "pytest-asyncio>=0.25.3",
     "mypy>=1.18.2",
+    "pdoc>=16.0.0",
 ]
 
 [tool.hatch.build.targets.wheel]