small rework with news boilerplate

Author: Corentin

.github/workflows/deploy-mkdocs.yml

@@ -0,0 +1,18 @@
+
+name: mkdocs 
+on:
+  push:
+    tags:
+      - "v*.*.*"
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -177,4 +177,5 @@ docker/run.sh
 *.tar.gz
 IMPatienT
 !data/images/demo_patient
-.idea
+.idea
+.ruff_cache

.vscode/settings.json

@@ -9,15 +9,8 @@
   "[html]": {
     "editor.defaultFormatter": "vscode.html-language-features"
   },
-  "python.linting.pylintEnabled": true,
   "python.linting.enabled": true,
   "python.formatting.provider": "black",
-  "python.linting.pylintArgs": [
-    "--load-plugins",
-    "pylint_flask_sqlalchemy",
-    "pylint_flask",
-    "--extension-pkg-whitelist=cv2"
-  ],
   "python.testing.pytestArgs": ["tests"],
   "python.testing.unittestEnabled": false,
   "python.testing.pytestEnabled": true,

Makefile

@@ -0,0 +1,42 @@
+black:
+	black app
+	black tests
+
+black-diff:
+	black app --diff
+	black tests --diff
+
+build: 
+	poetry build
+
+install:
+	poetry install
+	pre-commit install
+
+mkserve:
+	mkdocs serve
+
+mypy:
+	mypy app/ --ignore-missing-imports
+
+pre-commit: black mypy ruff test
+
+publish:
+	poetry publish
+
+publish-release: pre-commit build publish
+
+ruff:
+	ruff app tests
+
+test:
+	pytest tests
+
+_update:
+	poetry update
+
+update-all: _update publish-release
+
+update-all-diff:
+	poetry update --dry-run | grep -i updat
+

docs/api/impatient.md

@@ -0,0 +1 @@
+# IMPatienT

docs/examples/example.md

@@ -0,0 +1 @@
+# IMPatienT

docs/index.md

@@ -0,0 +1 @@
+# IMPatienT

docs/quickstart/advanced.md

@@ -0,0 +1 @@
+# IMPatienT

docs/quickstart/faq.md

@@ -0,0 +1 @@
+# IMPatienT

docs/quickstart/index.md

@@ -0,0 +1 @@
+# IMPatienT