Merge pull request #106 from ruby/gh-pages

Create documentation generated by rdoc with GitHub Actions

Author: shugo

.github/workflows/gh-pages.yml

@@ -0,0 +1,48 @@
+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@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@a4effe49ee8ee5b8b5091268c473a4628afb5651 # v1.245.0
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Install dependencies
+        run: gem install rdoc
+      - name: Build with RDoc
+        # Outputs to the './_site' directory by default
+        run: rake rdoc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  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

.gitignore

@@ -13,3 +13,4 @@
 /vendor/x64-mswin64*
 /ext/curses/Makefile
 .ruby-version
+_site

Rakefile

@@ -1,3 +1,14 @@
 require "bundler"
 
 Bundler::GemHelper.install_tasks
+
+begin
+  require "rdoc/task"
+  RDoc::Task.new do |doc|
+    doc.main   = "README.md"
+    doc.title  = "Curses: A Ruby binding for curses, ncurses, and PDCurses."
+    doc.rdoc_files = FileList.new %w[ext lib README.md BSDL COPYING]
+    doc.rdoc_dir = "_site" # for github pages
+  end
+rescue LoadError
+end