Add deploy docs workflow (#44)

Co-authored-by: Kutu <[email protected]>

.github/workflows/docs.yml

@@ -0,0 +1,24 @@
+name: Linting and formatting
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  run-docs:
+    runs-on: ubuntu-24.04
+
+    steps:
+      - run: sudo apt-get install -y just
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11.9"
+      - uses: actions/cache@v3
+        with:
+          path: .venv
+          key: ${{ runner.os }}-${{ hashFiles('requirements/requirements-docs.txt') }}
+      - run: just setup-docs
+      - run: just deploy-docs

TODO.md

@@ -1,7 +1,4 @@
 # TODO
 
-- [ ] Add `justfile`.
-- [ ] Remove `pre-commit`.
-    - [ ] Custom git-hooks?
 - [ ] Document in contributing why attributes are double typed.
 - [ ] Add general documentation and tutorials.

justfile

@@ -1,3 +1,4 @@
+# Default recipe of the justfile
 default: help
 
 # Show this info message
@@ -23,6 +24,11 @@ setup-tests: generic-setup
   .venv/bin/pip install .
   .venv/bin/pip install -r requirements/requirements-tests.txt
 
+[private]
+setup-docs: generic-setup
+  .venv/bin/pip install .
+  .venv/bin/pip install -r requirements/requirements-docs.txt
+
 # Check if the project is following the guidelines
 check:
   .venv/bin/mypy src/knuckles