Generate rdoc document by GitHub Pages Action

.github/workflows/gh-pages.yml

@@ -0,0 +1,46 @@
+name: Deploy RDoc site to Pages
+
+on:
+  push:
+    branches: [ 'master' ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@92aece5fc9c784ab66851c1e702b1bd5885a51f2 # v1.139.0
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+      - name: Build with RDoc
+        # Outputs to the './_site' directory by default
+        run: bundle exec rake rdoc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+
+  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@v1

.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+/_site

Rakefile

@@ -7,6 +7,14 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
+require "rdoc/task"
+RDoc::Task.new do |doc|
+  doc.main   = "README.md"
+  doc.title  = "URI - handle Uniform Resource Identifiers"
+  doc.rdoc_files = FileList.new %w[lib LICENSE.txt]
+  doc.rdoc_dir = "_site" # for github pages
+end
+
 task :sync_tool do
   require 'fileutils'
   FileUtils.cp "../ruby/tool/lib/test/unit/core_assertions.rb", "./test/lib"