feat(gmres.py): add documentation with pdoc

gmres.py/.envrc

@@ -0,0 +1,5 @@
+if command -v nix &> /dev/null; then
+    use nix
+fi
+
+# vim: ft=sh

gmres.py/.gitignore

@@ -0,0 +1,2 @@
+__pycache__/
+/docs

gmres.py/Justfile

@@ -0,0 +1,7 @@
+# Open documentation
+open-docs: build-docs
+	xdg-open ./docs/index.html
+
+# Build documentation using `pdoc`
+build-docs:
+	pdoc --math ./gmres.py -o ./docs

gmres.py/gmres.py

@@ -106,9 +106,7 @@ def test_arnoldi_iteration(
     # Check that Q_n is orthogonal
     # plt.imshow(qn.conj().T @ qn)
     # plt.show()
-    assert np.allclose(
-        qn.conj().T @ qn, np.eye(qn.shape[1]), rtol=rtol, atol=atol
-    )
+    assert np.allclose(qn.conj().T @ qn, np.eye(qn.shape[1]), rtol=rtol, atol=atol)
 
     # Check that AQ_n = Q_(n+1)H
     assert np.allclose(a @ qn, q @ h, rtol=rtol, atol=atol)

gmres.py/shell.nix

@@ -3,12 +3,14 @@
     with p; [
       matplotlib
       numpy
+      pdoc
       scipy
     ]);
 in
   pkgs.mkShell {
     packages = with pkgs; [
       ruff
+      just
       pythonWithPackages
     ];
   }