Improve config

.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: Publish
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+concurrency:
+  cancel-in-progress: true
+  group: publish-workflow
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: pipx install invoke poetry
+        shell: bash
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+          cache: poetry
+      - run: poetry install
+      - run: poetry run invoke deploy --force

mkdocs.yml

@@ -5,7 +5,32 @@ repo_url: https://github.com/MLOPS-University/mlops-coding-course
 site_name: MLOps Coding Course
 site_description: Learn how to create, develop, and maintain a state-of-the-art MLOps code base.
 site_autor: MLOps University
-copyright: CC BY
-# site_url: TODO
+site_url: https://mlops-university.github.io/mlops-coding-course/
+edit_uri: edit/main/docs/
 theme:
   name: material
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: purple
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: purple
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+  features:
+    - content.code.copy
+markdown_extensions:
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format

pyproject.toml

@@ -8,7 +8,7 @@ version = "0.0.1"
 package-mode = false
 description = "Learn how to create, develop, and maintain a state-of-the-art MLOps code base."
 repository = "https://github.com/MLOps-University/mlops-coding-course"
-documentation = "https://github.com/MLOps-University/mlops-coding-course"
+documentation = "https://mlops-university.github.io/mlops-coding-course/"
 authors = ["Médéric HURIER <[email protected]>"]
 readme = "README.md"
 license = "CC BY"

tasks.py

@@ -29,4 +29,4 @@ def serve(ctx: Context) -> None:
 @task
 def deploy(ctx: Context) -> None:
     """Deploy the documentation."""
-    ctx.run("poetry run mkdiocs gh-deploy")
+    ctx.run("poetry run mkdocs gh-deploy")