Merge pull request #5822 from nhsuk/rdoc-via-github-pages

Automated Technical Documentation using RDoc

Author: jhenderson

.github/workflows/deploy-documentation.yml

@@ -0,0 +1,33 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - release
+      - next
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-documentation:
+    name: Generate and Publish RDoc
+    runs-on: ubuntu-latest
+    concurrency:
+      group: deploy-documentation-${{ github.ref_name }}
+      cancel-in-progress: true
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+
+      - name: Generate Documentation
+        run: bundle exec rake rdocs:generate
+
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: docs/rdoc
+          target-folder: docs/rdoc/${{ github.ref_name }}
+          clean: false

lib/tasks/rdoc.rake

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rdoc/task"
+
+namespace :rdoc do
+  RDoc::Task.new(:generate) do |rdoc|
+    rdoc.title = "Mavis Documentation"
+    rdoc.main = "README.md"
+    rdoc.rdoc_dir = "docs/rdoc"
+    rdoc.rdoc_files.include(
+      "README.md",
+      "docs/*.md",
+      "lib/**/*.rb",
+      "app/**/*.rb"
+    )
+  end
+end