Merge pull request rails#47717 from p8/docs/include-readmes

p8 · web-flow · commit dc0f20595dd0 · 2023-03-30T16:43:14.000+02:00
Include READMEs in main framework pages of the API documentation
diff --git a/actioncable/lib/action_cable.rb b/actioncable/lib/action_cable.rb
@@ -43,6 +43,8 @@
   loader.inflector.inflect("postgresql" => "PostgreSQL")
 end.setup
 
+# :markup: markdown
+# :include: actioncable/README.md
 module ActionCable
   require_relative "action_cable/version"
   require_relative "action_cable/deprecator"
diff --git a/actionmailbox/lib/action_mailbox.rb b/actionmailbox/lib/action_mailbox.rb
@@ -8,6 +8,8 @@
 require "action_mailbox/deprecator"
 require "action_mailbox/mail_ext"
 
+# :markup: markdown
+# :include: actionmailbox/README.md
 module ActionMailbox
   extend ActiveSupport::Autoload
 
diff --git a/actionmailer/lib/action_mailer.rb b/actionmailer/lib/action_mailer.rb
@@ -35,6 +35,7 @@
 require "active_support/core_ext/string/inflections"
 require "active_support/lazy_load_hooks"
 
+# :include: actionmailer/README.rdoc
 module ActionMailer
   extend ::ActiveSupport::Autoload
 
diff --git a/actiontext/lib/action_text.rb b/actiontext/lib/action_text.rb
@@ -8,6 +8,8 @@
 
 require "nokogiri"
 
+# :markup: markdown
+# :include: actiontext/README.md
 module ActionText
   extend ActiveSupport::Autoload
 
diff --git a/actionview/lib/action_view.rb b/actionview/lib/action_view.rb
@@ -28,6 +28,7 @@
 require "action_view/version"
 require "action_view/deprecator"
 
+# :include: actionview/README.rdoc
 module ActionView
   extend ActiveSupport::Autoload
 
diff --git a/activejob/lib/active_job.rb b/activejob/lib/active_job.rb
@@ -29,6 +29,8 @@
 require "active_job/deprecator"
 require "global_id"
 
+# :markup: markdown
+# :include: activejob/README.md
 module ActiveJob
   extend ActiveSupport::Autoload
 
diff --git a/activemodel/lib/active_model.rb b/activemodel/lib/active_model.rb
@@ -28,6 +28,7 @@
 require "active_model/version"
 require "active_model/deprecator"
 
+# :include: activemodel/README.rdoc
 module ActiveModel
   extend ActiveSupport::Autoload
 
diff --git a/activerecord/lib/active_record.rb b/activerecord/lib/active_record.rb
@@ -34,6 +34,7 @@
 require "active_model/attribute_set"
 require "active_record/errors"
 
+# :include: activerecord/README.rdoc
 module ActiveRecord
   extend ActiveSupport::Autoload
 
diff --git a/activestorage/lib/active_storage.rb b/activestorage/lib/active_storage.rb
@@ -34,6 +34,8 @@
 
 require "marcel"
 
+# :markup: markdown
+# :include: activestorage/README.md
 module ActiveStorage
   extend ActiveSupport::Autoload
 
diff --git a/activesupport/lib/active_support.rb b/activesupport/lib/active_support.rb
@@ -31,6 +31,7 @@
 require "active_support/lazy_load_hooks"
 require "active_support/core_ext/date_and_time/compatibility"
 
+# :include: activesupport/README.rdoc
 module ActiveSupport
   extend ActiveSupport::Autoload
 
diff --git a/railties/lib/rails.rb b/railties/lib/rails.rb
@@ -24,6 +24,7 @@
   Encoding.default_internal = Encoding::UTF_8
 end
 
+# :include: railties/README.rdoc
 module Rails
   extend ActiveSupport::Autoload
   extend ActiveSupport::Benchmarkable
diff --git a/railties/lib/rails/api/task.rb b/railties/lib/rails/api/task.rb
@@ -10,13 +10,15 @@ class Task < RDoc::Task
         "activesupport" => {
           include: %w(
             README.rdoc
+            lib/active_support.rb
             lib/active_support/**/*.rb
           )
         },
 
         "activerecord" => {
           include: %w(
             README.rdoc
+            lib/active_record.rb
             lib/active_record/**/*.rb
             lib/arel.rb
           )
@@ -25,6 +27,7 @@ class Task < RDoc::Task
         "activemodel" => {
           include: %w(
             README.rdoc
+            lib/active_model.rb
             lib/active_model/**/*.rb
           )
         },
@@ -41,6 +44,7 @@ class Task < RDoc::Task
         "actionview" => {
           include: %w(
             README.rdoc
+            lib/action_view.rb
             lib/action_view/**/*.rb
           ),
           exclude: "lib/action_view/vendor/*"
@@ -49,20 +53,23 @@ class Task < RDoc::Task
         "actionmailer" => {
           include: %w(
             README.rdoc
+            lib/action_mailer.rb
             lib/action_mailer/**/*.rb
           )
         },
 
         "activejob" => {
           include: %w(
             README.md
+            lib/active_job.rb
             lib/active_job/**/*.rb
           )
         },
 
         "actioncable" => {
           include: %w(
             README.md
+            lib/action_cable.rb
             lib/action_cable/**/*.rb
           )
         },
@@ -71,6 +78,7 @@ class Task < RDoc::Task
           include: %w(
             README.md
             app/**/active_storage/**/*.rb
+            lib/active_storage.rb
             lib/active_storage/**/*.rb
           )
         },
@@ -79,6 +87,7 @@ class Task < RDoc::Task
           include: %w(
             README.md
             app/**/action_mailbox/**/*.rb
+            lib/action_mailbox.rb
             lib/action_mailbox/**/*.rb
           )
         },
@@ -87,6 +96,7 @@ class Task < RDoc::Task
           include: %w(
             README.md
             app/**/action_text/**/*.rb
+            lib/action_text.rb
             lib/action_text/**/*.rb
           )
         },
