rails/actionmailbox/lib/action_mailbox.rb
Petrik 7c94708d24 Include READMEs in main framework pages of the API documentation
Currently when opening the main framework pages there is no introduction
to the framework. Instead we only see a whole lot of modules and the
`gem_version` and `version` methods.

By including the READMEs using the `:include:` directive each frameworks
has a nice introduction.
For markdown READMEs we need to add the :markup: directive.

[ci-skip]

Co-authored-by: zzak <zzakscott@gmail.com>
2023-03-21 21:16:28 +01:00

27 lines
632 B
Ruby

# frozen_string_literal: true
require "active_support"
require "active_support/rails"
require "active_support/core_ext/numeric/time"
require "action_mailbox/version"
require "action_mailbox/deprecator"
require "action_mailbox/mail_ext"
# :markup: markdown
# :include: actionmailbox/README.md
module ActionMailbox
extend ActiveSupport::Autoload
autoload :Base
autoload :Router
autoload :TestCase
mattr_accessor :ingress
mattr_accessor :logger
mattr_accessor :incinerate, default: true
mattr_accessor :incinerate_after, default: 30.days
mattr_accessor :queues, default: {}
mattr_accessor :storage_service
end