Add docs to GitHub pages.

Author: alanderex

.github/workflows/deploy-docs.yml

@@ -0,0 +1,47 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'README.md'
+      - '.github/workflows/deploy-docs.yml'
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        
+      - name: Install dependencies
+        run: |
+          uv venv
+          source .venv/bin/activate
+          uv pip install -e .
+          
+      - name: Install Cairo dependencies (for social cards)
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libcairo2-dev libpango1.0-dev
+          
+      - name: Build and deploy docs
+        run: |
+          source .venv/bin/activate
+          uv run mkdocs gh-deploy --force

scripts/hook_add_logo_to_social_cards.py

@@ -2,6 +2,7 @@
 Script to manually add the Pioneers Hub logo to the social cards of website.
 This is not supported by the open version of mkdocs-material, yet.
 """
+
 from pathlib import Path
 
 from PIL import Image
@@ -17,12 +18,12 @@ def on_post_build(config):
     the_logo_position = (960, 450)
     base_width = 175
     ph_logo = Image.open(path_to_logo)
-    w_percent = (base_width / ph_logo.size[0])
+    w_percent = base_width / ph_logo.size[0]
     h_size = int(float(ph_logo.size[1]) * float(w_percent))
     ph_logo = ph_logo.resize((base_width, h_size), Image.Resampling.LANCZOS)
-    for k, dir_from_project_root in xtra["social_cards"]["dirs"].items():
+    for _, dir_from_project_root in xtra["social_cards"]["dirs"].items():
         read_dir = root / dir_from_project_root
-        for social_card in read_dir.glob('*.png'):
+        for social_card in read_dir.glob("*.png"):
             # Get the social card image
             social_card_image = Image.open(social_card)
             # Paste the Pioneers Hub logo onto the social card image

scripts/hook_copyright_year.py

@@ -1,10 +1,13 @@
-""" Alter config on run
- https://www.mkdocs.org/user-guide/configuration/#hooks
- """
+"""Alter config on run
+https://www.mkdocs.org/user-guide/configuration/#hooks
+"""
+
 from datetime import datetime
 
 
-def on_config(config, **kwargs):
+def on_config(config, **kwargs):  # noqa ARG001
     config.copyright = f"Copyright © {datetime.now().year} Your Name"
-    config.copyright = (f'Copyright © 2024{"-" + str(datetime.now().year) if datetime.now().year > 2024 else ""} Pioneers Hub gGmbH – '
-                        f'<a href="#__consent">Change cookie settings</a>')
+    config.copyright = (
+        f"Copyright © 2024{'-' + str(datetime.now().year) if datetime.now().year > 2024 else ''} Pioneers Hub gGmbH – "  # noqa: PLR2004
+        f'<a href="#__consent">Change cookie settings</a>'
+    )