build docs in CI

Author: mxmpl

.github/workflows/docs.yaml

@@ -0,0 +1,43 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: macos-latest # Faster PyTorch installation
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install pandoc
+        uses: pandoc/actions/setup@v1
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Build the doc
+        run: make docs
+
+      - name: Upload static files
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Makefile

@@ -0,0 +1,6 @@
+.PHONY: docs
+
+docs:
+	rm -rf docs/build
+	uv run --group doc jupyter nbconvert --clear-output --inplace docs/**/*.ipynb
+	uv run --group doc sphinx-build -b html docs docs/build

docs/Makefile

@@ -2,11 +2,11 @@
 API reference
 =============
 
+.. autofunction:: fastabx.zerospeech_abx
+
 Standard classes and functions
 ==============================
 
-.. autofunction:: fastabx.zerospeech_abx
-
 Dataset
 -------
 
@@ -53,4 +53,4 @@ DTW
 ---
 
 .. autofunction:: fastabx.dtw.dtw
-.. autofunction:: fastabx.dtw.dtw_batch
+.. autofunction:: fastabx.dtw.dtw_batch

docs/api.rst

@@ -17,6 +17,6 @@
 version = metadata(project)["Version"]
 release = version
 
+autodoc_typehints = "description"
 exclude_patterns = ["build"]
 html_theme = "furo"
-html_static_path = ["_static"]

docs/conf.py

@@ -2,8 +2,8 @@
 Install
 =======
 
-Installing the latest release
-=============================
+Latest release
+==============
 
 Install the package with pip:
 
@@ -16,8 +16,8 @@ The pinned PyTorch version is the one available on PyPI.
 
 fastabx is available on Linux x86-64 and aarch64 (with glibc 2.34 or later [#glibc]_), macOS arm64, and Windows x86-64.
 
-Building from source
-====================
+Build from source
+=================
 
 1. Clone the repository:
 
@@ -45,4 +45,4 @@ Footnotes
    This means you have to have to use the exact version of PyTorch this package was compiled against.
 
 .. [#glibc] The glibc constraint is due to the runners available in GitHub CI. If you build from source,
-   you can use the lowest version of glibc supported by PyTorch.
+   you can use the lowest version of glibc supported by PyTorch.