Initial commit from pymetrius template

.github/workflows/lint_and_docs.yaml

@@ -0,0 +1,51 @@
+name: Linting, Types and Docs Check
+
+on: [push, pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      pages: write
+      actions: write
+      contents: read
+    steps:
+      - name: Cancel previous run
+        uses: styfle/cancel-workflow-action@0.11.0
+        with:
+          access_token: ${{ github.token }}
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      
+      
+      # use uv package manager
+      - name: Install uv
+        run: pip install uv
+      - uses: actions/cache@v3
+        name: Cache dependencies
+        with:
+          path: ~/.cache/uv
+          key: uv-${{ hashFiles('pyproject.toml') }}
+      - name: Install dependencies
+        run: |
+          uv venv
+          uv pip install -e ".[dev]"
+      - name: Lint
+        run: uv run poe lint
+      - name: Types
+        run: uv run poe type-check
+      - name: Docs
+        run: uv run poe doc-build
+      
+      
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: "docs/_build"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2