Clean up RDoc Pages workflow

Author: st0012

.document

@@ -1,14 +1,5 @@
 README.md
 CONTRIBUTING.md
 docs/*.md
-docs/rdoc-extension-root.c
-lib
-ext/rubydex/rubydex.c
-ext/rubydex/graph.c
-ext/rubydex/declaration.c
-ext/rubydex/definition.c
-ext/rubydex/document.c
-ext/rubydex/reference.c
-ext/rubydex/signature.c
-ext/rubydex/location.c
-ext/rubydex/diagnostic.c
+lib/**/*.rb
+ext/rubydex/*.c

.github/workflows/pages.yml

@@ -25,17 +25,17 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@89f90524b88a01fe6e0b732220432cc6142926af # v1.313.0
         with:
-          ruby-version: "3.4"
+          ruby-version: "4.0.0"
           bundler-cache: true
 
       - name: Setup Pages
-        uses: actions/configure-pages@v6
+        uses: actions/configure-pages@v6.0.0
 
-      - name: Build and verify documentation
-        run: bundle exec rake rdoc:verify
+      - name: Build documentation
+        run: bundle exec rake rdoc
 
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v5
+        uses: actions/upload-pages-artifact@v5.0.0
 
   deploy:
     environment:
@@ -46,4 +46,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v5
+        uses: actions/deploy-pages@v5.0.0

.rdoc_options

@@ -2,12 +2,6 @@ op_dir: _site
 title: Rubydex
 main_page: README.md
 
-exclude:
-- AGENTS.md
-- CLAUDE.md
-- tmp
-- rust
-
 footer_content:
   DOCUMENTATION:
     Home: index.html

Rakefile

@@ -33,61 +33,6 @@ RDoc::Task.new do |doc|
   doc.rdoc_dir = "_site"
 end
 
-namespace :rdoc do
-  desc "Verify the generated RDoc site includes the public Ruby and native extension APIs"
-  task :verify do
-    Rake::Task["rdoc"].invoke
-
-    html_files = FileList["_site/**/*.html"]
-    abort "Generated RDoc site is empty" if html_files.empty?
-
-    expected_pages = {
-      "_site/Rubydex/Graph.html" => [
-        'id="class-rubydex-graph"',
-        'id="method-i-index_workspace"',
-        'id="method-i-workspace_paths"',
-        'id="method-i-index_all"',
-        'id="method-i-index_source"',
-        'index_source(uri, source, language_id)',
-        'id="method-i-keyword"',
-        'id="method-i-exclude_paths"',
-        'id="method-i-resolve_constant"',
-      ],
-      "_site/Rubydex/Declaration.html" => [
-        'id="class-rubydex-declaration"',
-      ],
-      "_site/Rubydex/Signature.html" => [
-        'id="class-rubydex-signature"',
-      ],
-      "_site/Rubydex/Document.html" => [
-        'id="class-rubydex-document"',
-        'id="method-i-uri"',
-        'id="method-i-definitions"',
-      ],
-      "_site/Rubydex/Definition.html" => [
-        'id="class-rubydex-definition"',
-        'id="method-i-location"',
-        'id="method-i-comments"',
-      ],
-      "_site/Rubydex/ResolvedConstantReference.html" => [
-        'id="class-rubydex-resolvedconstantreference"',
-        'id="method-i-declaration"',
-      ],
-    }
-
-    missing = expected_pages.flat_map do |file, entries|
-      unless File.exist?(file)
-        next ["#{file} was not generated"]
-      end
-
-      content = File.read(file)
-      entries.reject { |entry| content.include?(entry) }.map { |entry| "#{file}: #{entry}" }
-    end
-
-    abort "Generated RDoc site is missing expected API entries:\n  - #{missing.join("\n  - ")}" unless missing.empty?
-  end
-end
-
 task :lint do
   puts "******** Linting ********\n"
   Rake::Task["rubocop"].invoke

docs/rdoc-extension-root.c

@@ -5,6 +5,11 @@
 #include "rustbindings.h"
 #include "utils.h"
 
+/*
+ * RDoc parser workaround for https://github.com/ruby/rdoc/issues/1744:
+ * mRubydex = rb_define_module("Rubydex")
+ */
+
 VALUE cDeclaration;
 VALUE cNamespace;
 VALUE cClass;

ext/rubydex/declaration.c

@@ -8,6 +8,11 @@
 #include "ruby/internal/scan_args.h"
 #include "rustbindings.h"
 
+/*
+ * RDoc parser workaround for https://github.com/ruby/rdoc/issues/1744:
+ * mRubydex = rb_define_module("Rubydex")
+ */
+
 static VALUE mRubydex;
 static VALUE cInclude;
 static VALUE cPrepend;

ext/rubydex/definition.c

@@ -1,6 +1,11 @@
 #include "diagnostic.h"
 #include "rustbindings.h"
 
+/*
+ * RDoc parser workaround for https://github.com/ruby/rdoc/issues/1744:
+ * mRubydex = rb_define_module("Rubydex")
+ */
+
 VALUE cDiagnostic;
 
 void rdxi_initialize_diagnostic(VALUE mRubydex) { cDiagnostic = rb_define_class_under(mRubydex, "Diagnostic", rb_cObject); }

ext/rubydex/diagnostic.c

@@ -4,6 +4,11 @@
 #include "handle.h"
 #include "rustbindings.h"
 
+/*
+ * RDoc parser workaround for https://github.com/ruby/rdoc/issues/1744:
+ * mRubydex = rb_define_module("Rubydex")
+ */
+
 VALUE cDocument;
 
 /*

ext/rubydex/document.c

@@ -8,6 +8,11 @@
 #include "rustbindings.h"
 #include "utils.h"
 
+/*
+ * RDoc parser workaround for https://github.com/ruby/rdoc/issues/1744:
+ * mRubydex = rb_define_module("Rubydex")
+ */
+
 static VALUE cGraph;
 static VALUE mRubydex;
 static VALUE cKeyword;