Publish YARD documentation to GitHub Pages

Add a workflow that builds the YARD docs and deploys them to GitHub
Pages on every push to master.

Wire up YARD itself: yard and redcarpet as development dependencies,
plus a :doc Rake task matching the one in validates_im.

Trim .document to the Ruby sources it covers. It still listed
Jeweler-era paths alongside Markdown and bin/*, all of which YARD
merged into its inputs and tried to parse as Ruby.

Point the gemspec's documentation_uri at the new Pages site.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

Author: RISCfuture

.document

@@ -1,5 +1 @@
-README.rdoc
 lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

.github/workflows/documentation.yml

@@ -0,0 +1,45 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "4.0"
+          bundler-cache: true
+      - name: Build documentation
+        run: bundle exec rake doc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: ./doc
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

Gemfile

@@ -3,3 +3,8 @@
 source "https://rubygems.org"
 
 gemspec
+
+group :development do
+  gem "redcarpet", require: false
+  gem "yard", require: false
+end

Gemfile.lock

@@ -55,6 +55,7 @@ GEM
     public_suffix (7.0.5)
     rack (3.2.6)
     rake (13.4.2)
+    redcarpet (3.6.1)
     rexml (3.4.4)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
@@ -77,16 +78,19 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.45)
 
 PLATFORMS
   arm64-darwin-25
   ruby
 
 DEPENDENCIES
   rake (~> 13.0)
+  redcarpet
   rspec (~> 3.13)
   url_validation!
   webmock (~> 3.0)
+  yard
 
 CHECKSUMS
   activemodel (8.1.3) sha256=90c05cbe4cef3649b8f79f13016191ea94c4525ce4a5c0fb7ef909c4b91c8219
@@ -111,6 +115,7 @@ CHECKSUMS
   public_suffix (7.0.5) sha256=1a8bb08f1bbea19228d3bed6e5ed908d1cb4f7c2726d18bd9cadf60bc676f623
   rack (3.2.6) sha256=5ed78e1f73b2e25679bec7d45ee2d4483cc4146eb1be0264fc4d94cb5ef212c2
   rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  redcarpet (3.6.1) sha256=d444910e6aa55480c6bcdc0cdb057626e8a32c054c29e793fa642ba2f155f445
   rexml (3.4.4) sha256=19e0a2c3425dfbf2d4fc1189747bdb2f849b6c5e74180401b15734bc97b5d142
   rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
   rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
@@ -122,6 +127,7 @@ CHECKSUMS
   uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6
   url_validation (2.0.0)
   webmock (3.26.2) sha256=774556f2ea6371846cca68c01769b2eac0d134492d21f6d0ab5dd643965a4c90
+  yard (0.9.45) sha256=52e211493f7cb8a3ebf7e104a25a1e73937a3103092545d34cb88fafebb3dc51
 
 BUNDLED WITH
   4.0.16

Rakefile

@@ -5,4 +5,19 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new(:doc) do |doc|
+    doc.options += ["--markup", "markdown"]
+    doc.options += ["--markup-provider", "redcarpet"]
+    doc.options += ["--protected", "--no-private"]
+    doc.options += ["--readme", "README.md"]
+    doc.options += ["--output-dir", "doc"]
+    doc.options += ["--title", "url_validation Documentation"]
+    doc.files = %w[lib/**/*.rb]
+  end
+rescue LoadError
+  # YARD is optional
+end
+
 task default: :spec

url_validation.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata = {
     "homepage_uri"          => spec.homepage,
+    "documentation_uri"     => "https://riscfuture.github.io/url_validation/",
     "bug_tracker_uri"       => "#{spec.homepage}/issues",
     "changelog_uri"         => "#{spec.homepage}/blob/master/CHANGELOG.md",
     "rubygems_mfa_required" => "true"