docs: add workflow to create and publish docs

Author: SauravMaheshkar

.github/workflows/docs.yml

@@ -0,0 +1,69 @@
+name: "build and deploy docs to github pages"
+
+on:
+    push:
+        branches: [main]
+
+    pull_request:
+        branches: [main]
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+concurrency:
+    group: deploy
+    cancel-in-progress: false
+
+jobs:
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup Rust
+              uses: dtolnay/rust-toolchain@nightly
+              with:
+                  targets: x86_64-unknown-none
+
+            - name: Add components
+              run: rustup component add rust-src --toolchain nightly-x86_64-unknown-linux-gnu
+
+            - name: Configure cache
+              uses: Swatinem/rust-cache@v2
+
+            - name: Setup pages
+              id: pages
+              uses: actions/configure-pages@v5
+
+            - name: Clean docs folder
+              run: cargo clean --doc -Z bindeps
+
+            - name: Build docs
+              run: cd src/kernel && cargo doc -Zbuild-std --no-deps --document-private-items
+
+            - name: Add redirect
+              run: echo '<meta http-equiv="refresh" content="0;url=kernel/index.html">' > target/x86_64-unknown-none/doc/index.html
+
+            - name: Remove lock file
+              run: rm target/x86_64-unknown-none/doc/.lock
+
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: target/x86_64-unknown-none/doc
+
+    deploy:
+        name: Deploy
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        needs: build
+        steps:
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4