Merge branch 'main' into cuda

Author: tychedelia

.github/workflows/docs.yml

@@ -0,0 +1,68 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - uses: ./.github/actions/setup
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - uses: astral-sh/setup-uv@v6
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-docs-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-docs-
+            ${{ runner.os }}-cargo-
+
+      - name: Build extension and generate stubs
+        run: |
+          cd crates/processing_pyo3
+          uv run maturin develop --release
+          cd ../..
+          cargo run --release -p generate_stubs
+
+      - name: Build docs
+        run: uv run --project crates/processing_pyo3 --group docs mkdocs build
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,4 +1,6 @@
 /target/
+/site/
 crates/processing_ffi/include/
+crates/processing_pyo3/mewnala/*.pyi
 .DS_Store
 .ipynb_checkpoints/

README.md

@@ -10,30 +10,43 @@ Inside of our `processing_pyo3` crate we have created a python package that you
 Again, we are still very nascent, but let us know what kinds of snags you may run into while getting this set up.
 Try running the examples in the [processing_pyo3 examples directory](crates/processing_pyo3/examples).
 
-```bash
-# have python3 installed on your system
+We are big fans of [uv](https://github.com/astral-sh/uv) and this is the easiest way to get started using `mewnala`
 
-# create a sketch folder and go inside
-mkdir my-sketch-folder && cd my-sketch-folder
+#### Setting up uv on linux or macOS
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
 
-# create a virtual env
-python -m venv .venv
+#### For Windows users:
+```bash
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
 
-# activate virtual env
-source .venv/bin/activate
+#### Install a mewnala
+```bash
+# Initialize a project with uv
+uv init mewnala-sketchbook && cd mewnala-sketchbook
 
-pip install mewnala
+# add the package
+uv add mewnala
 
-python my_sketch.py
+# run a sketch
+uv run sketch.py
 ```
 
-### Rust
+### Rust (libprocessing)
 
 You'll need to install the Rust toolchain to work on this project. Most users will want to install Rust via [`rustup`](https://rustup.rs/), which helps manage Rust toolchain versions.
 
 ### Build commands
 
-This project uses [just](https://github.com/casey/just) as a command runner. Run `just` to see available commands.
+This project uses [just](https://github.com/casey/just) as a command runner:
+
+```bash
+cargo install just
+```
+
+Run `just` to see available commands.
 
 ## Building for web
 

crates/processing_pyo3/pyproject.toml

@@ -35,6 +35,11 @@ Issues = "https://github.com/processing/libprocessing/issues"
 
 [dependency-groups]
 dev = ["maturin>=1.10,<2.0"]
+docs = [
+    "mkdocs-material>=9.6",
+    "mkdocstrings[python]>=0.29",
+    "mkdocs-gen-files>=0.5",
+]
 
 [tool.maturin]
 manifest-path = "Cargo.toml"