Class: Raddocs::Configuration
- Inherits:
-
Object
- Object
- Raddocs::Configuration
- Defined in:
- lib/raddocs/configuration.rb
Overview
Configure Raddocs
Instance Attribute Summary collapse
-
#api_name ⇒ String
Defaults to “Api Documentation”.
-
#docs_dir ⇒ String
Defaults to ‘doc/api’.
-
#docs_mime_type ⇒ Regexp
Defaults to Regexp.new(“text/docs+plain”).
-
#external_css ⇒ Array
Array of Strings, defaults to [].
-
#guides_dir ⇒ String
Defaults to ‘doc/guides’.
-
#include_bootstrap ⇒ Boolean
Defaults to true.
-
#url_prefix ⇒ String
Defaults to nil.
Class Method Summary collapse
-
.add_setting(name, opts = {}) ⇒ Object
Configures a new setting, creates two methods.
Instance Attribute Details
#api_name ⇒ String
Returns defaults to “Api Documentation”.
42 |
# File 'lib/raddocs/configuration.rb', line 42 add_setting :api_name, :default => "Api Documentation" |
#docs_dir ⇒ String
Returns defaults to ‘doc/api’.
30 |
# File 'lib/raddocs/configuration.rb', line 30 add_setting :docs_dir, :default => "doc/api" |
#docs_mime_type ⇒ Regexp
Returns defaults to Regexp.new(“text/docs+plain”).
38 |
# File 'lib/raddocs/configuration.rb', line 38 add_setting :docs_mime_type, :default => /text\/docs\+plain/ |
#external_css ⇒ Array
Returns array of Strings, defaults to [].
50 |
# File 'lib/raddocs/configuration.rb', line 50 add_setting :external_css, :default => [] |
#guides_dir ⇒ String
Returns defaults to ‘doc/guides’.
34 |
# File 'lib/raddocs/configuration.rb', line 34 add_setting :guides_dir, :default => "doc/guides" |
#include_bootstrap ⇒ Boolean
Returns defaults to true.
46 |
# File 'lib/raddocs/configuration.rb', line 46 add_setting :include_bootstrap, :default => true |
#url_prefix ⇒ String
Returns defaults to nil.
54 |
# File 'lib/raddocs/configuration.rb', line 54 add_setting :url_prefix, :default => nil |
Class Method Details
.add_setting(name, opts = {}) ⇒ Object
Configures a new setting, creates two methods
15 16 17 18 19 20 21 22 23 24 25 26 |
# File 'lib/raddocs/configuration.rb', line 15 def self.add_setting(name, opts = {}) define_method("#{name}=") { |value| settings[name] = value } define_method("#{name}") do if settings.has_key?(name) settings[name] elsif opts[:default].respond_to?(:call) opts[:default].call(self) else opts[:default] end end end |