add job for publishing crate docs to GH pages

yshavit · web-flow · commit 22fbdc8fa25d · 2025-04-02T01:16:48.000-04:00
resolves #311
diff --git a/.github/gha_assets/crate-doc-root-redirect.html b/.github/gha_assets/crate-doc-root-redirect.html
@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Redirecting...</title>
+    <meta http-equiv="refresh" content="0; URL='./mdq'"/>
+    <style>
+        body {
+            font-family: Arial, sans-serif;
+            margin: 0;
+            padding: 20px;
+            display: flex;
+            justify-content: center;
+            align-items: center;
+            height: 100vh;
+            background-color: #f5f5f5;
+        }
+
+        .redirect-message {
+            text-align: center;
+            padding: 20px;
+            background-color: white;
+            border-radius: 8px;
+            box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
+        }
+
+        h1 {
+            color: #333;
+        }
+
+        p {
+            color: #666;
+        }
+
+        a {
+            color: #0066cc;
+            text-decoration: none;
+        }
+    </style>
+</head>
+<body>
+<div class="redirect-message">
+    <h1>Redirecting...</h1>
+    <p>You are being redirected to <a href="./mdq">./mdq</a>.</p>
+    <p>If you are not redirected automatically, please click the link above.</p>
+</div>
+</body>
+</html>
diff --git a/.github/workflows/readme-checks.yml b/.github/workflows/readme-checks.yml
@@ -45,3 +45,40 @@ jobs:
           exit "$exit_code"
         env:
           MSRV_VERSION: ${{ steps.run-msrv.outputs.result }}
+
+  build-crate-docs:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build docs
+        run: cargo doc --no-deps
+
+      - name: Add redirect page
+        run: cp .github/gha_assets/crate-doc-root-redirect.html target/doc/index.html
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: target/doc
+
+  deploy-crate-docs:
+    needs: build-crate-docs
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    concurrency:
+      group: "pages"
+      cancel-in-progress: false
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    steps:
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
