Use relative includes of README's in documentation [ci-skip]

The Rails documentation uses the `:include:` directive to inline the README of the framework into the main documentation page. As the README's aren't in the root directory from where SDoc is run we need to add the framework path to the include: # :include: activesupport/README.md This results in a warning when installing the gems as generating the rdoc for the gem is run from the gem/framework root: Couldn't find file to include 'activesupport/README.rdoc' from lib/active_support.rb The `:include:` RDoc directive supports includes relative to the current file as well: # :include: ../README.md This makes sure it works for the Rails API docs and the separate gems. Co-authored-by: Jonathan Hefner <[email protected]>
viralpraxis · Mar 24, 2024 · 7456783 · 7456783
1 parent a040d67
commit 7456783
Show file tree

Hide file tree

Showing 11 changed files with 11 additions and 11 deletions.
diff --git a/actioncable/lib/action_cable.rb b/actioncable/lib/action_cable.rb
@@ -44,7 +44,7 @@
 end.setup
 
 # :markup: markdown
-# :include: actioncable/README.md
+# :include: ../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
@@ -9,7 +9,7 @@
 require "action_mailbox/mail_ext"
 
 # :markup: markdown
-# :include: actionmailbox/README.md
+# :include: ../README.md
 module ActionMailbox
   extend ActiveSupport::Autoload
 

diff --git a/actionmailer/lib/action_mailer.rb b/actionmailer/lib/action_mailer.rb
@@ -35,7 +35,7 @@
 require "active_support/core_ext/string/inflections"
 require "active_support/lazy_load_hooks"
 
-# :include: actionmailer/README.rdoc
+# :include: ../README.rdoc
 module ActionMailer
   extend ::ActiveSupport::Autoload
 

diff --git a/actiontext/lib/action_text.rb b/actiontext/lib/action_text.rb
@@ -9,7 +9,7 @@
 require "nokogiri"
 
 # :markup: markdown
-# :include: actiontext/README.md
+# :include: ../README.md
 module ActionText
   extend ActiveSupport::Autoload
 

diff --git a/actionview/lib/action_view.rb b/actionview/lib/action_view.rb
@@ -28,7 +28,7 @@
 require "action_view/version"
 require "action_view/deprecator"
 
-# :include: actionview/README.rdoc
+# :include: ../README.rdoc
 module ActionView
   extend ActiveSupport::Autoload
 

diff --git a/activejob/lib/active_job.rb b/activejob/lib/active_job.rb
@@ -30,7 +30,7 @@
 require "global_id"
 
 # :markup: markdown
-# :include: activejob/README.md
+# :include: ../README.md
 module ActiveJob
   extend ActiveSupport::Autoload
 

diff --git a/activemodel/lib/active_model.rb b/activemodel/lib/active_model.rb
@@ -28,7 +28,7 @@
 require "active_model/version"
 require "active_model/deprecator"
 
-# :include: activemodel/README.rdoc
+# :include: ../README.rdoc
 module ActiveModel
   extend ActiveSupport::Autoload
 

diff --git a/activerecord/lib/active_record.rb b/activerecord/lib/active_record.rb
@@ -35,7 +35,7 @@
 require "active_model/attribute_set"
 require "active_record/errors"
 
-# :include: activerecord/README.rdoc
+# :include: ../README.rdoc
 module ActiveRecord
   extend ActiveSupport::Autoload
 

diff --git a/activestorage/lib/active_storage.rb b/activestorage/lib/active_storage.rb
@@ -35,7 +35,7 @@
 require "marcel"
 
 # :markup: markdown
-# :include: activestorage/README.md
+# :include: ../README.md
 module ActiveStorage
   extend ActiveSupport::Autoload
 

diff --git a/activesupport/lib/active_support.rb b/activesupport/lib/active_support.rb
@@ -32,7 +32,7 @@
 require "active_support/lazy_load_hooks"
 require "active_support/core_ext/date_and_time/compatibility"
 
-# :include: activesupport/README.rdoc
+# :include: ../README.rdoc
 module ActiveSupport
   extend ActiveSupport::Autoload
 

diff --git a/railties/lib/rails.rb b/railties/lib/rails.rb
@@ -22,7 +22,7 @@
   Encoding.default_internal = Encoding::UTF_8
 end
 
-# :include: railties/README.rdoc
+# :include: ../README.rdoc
 module Rails
   extend ActiveSupport::Autoload
   extend ActiveSupport::Benchmarkable