Module: Documentation

Defined in:
lib/documentation.rb,
lib/documentation/config.rb,
lib/documentation/engine.rb,
lib/documentation/errors.rb,
lib/documentation/version.rb,
lib/documentation/authorizer.rb,
app/models/documentation/page.rb,
lib/documentation/view_helpers.rb,
lib/documentation/search_result.rb,
lib/documentation/searchers/simple.rb,
app/models/documentation/screenshot.rb,
lib/documentation/markdown_renderer.rb,
lib/documentation/searchers/abstract.rb,
app/helpers/documentation/application_helper.rb,
lib/documentation/generators/setup_generator.rb,
app/controllers/documentation/pages_controller.rb,
app/controllers/documentation/application_controller.rb

Defined Under Namespace

Modules: ApplicationHelper, Generators, Searchers, ViewHelpers Classes: AccessDeniedError, ApplicationController, Authorizer, Engine, Error, MarkdownRenderer, Page, PagesController, Screenshot, SearchResult

Constant Summary collapse

DEFAULT_CONFIGURATION =

Sets the default configuration

{
  # This defines the at path where a page can be viewed in
  # the source website. For example, /docs/
  :preview_path_prefix => nil,

  # Should we display developer tips in the UI?
  :developer_tips => true,

  # The authorizer to use
  :authorizer => Documentation::Authorizer,
  
  # The searcher to use
  :searcher => Documentation::Searchers::Simple.new
}
VERSION = 
'1.0.7'

Class Method Summary collapse

Class Method Details

.config ⇒ Object

Return configuration options



27
28
29
 
# File 'lib/documentation/config.rb', line 27

def self.config
  @config ||= OpenStruct.new(DEFAULT_CONFIGURATION)
end