Class: RDoc::Generator::SDoc

Inherits:
Object
  • Object
show all
Includes:
ERB::Util, SDoc::GitHub, SDoc::Helpers, SDoc::Templatable
Defined in:
lib/sdoc/generator.rb

Defined Under Namespace

Classes: FilesTree

Constant Summary collapse

DESCRIPTION = 
'Searchable HTML documentation'
GENERATOR_DIRS = 
[File.join('sdoc', 'generator')]
TYPE_CLASS =

Used in js to reduce index sizes

1
TYPE_METHOD = 
2
TYPE_FILE = 
3
TREE_FILE = 
File.join 'panel', 'tree.js'
SEARCH_INDEX_FILE = 
File.join 'panel', 'search_index.js'
FILE_DIR = 
'files'
CLASS_DIR = 
'classes'
RESOURCES_DIR = 
File.join('resources', '.')

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ SDoc

Returns a new instance of SDoc.



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/sdoc/generator.rb', line 164

def initialize(options)
  @options = options
  if @options.respond_to?('diagram=')
    @options.diagram = false
  end
  @github_url_cache = {}

  @template_dir = Pathname.new(options.template_dir)
  @basedir = Pathname.pwd.expand_path
end

Instance Attribute Details

#basedir ⇒ Object (readonly)

Returns the value of attribute basedir.



132
133
134
 
# File 'lib/sdoc/generator.rb', line 132

def basedir
  @basedir
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



134
135
136
 
# File 'lib/sdoc/generator.rb', line 134

def options
  @options
end

Class Method Details

.setup_options(options) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/sdoc/generator.rb', line 136

def self.setup_options(options)
  @github = false
  options.se_index = true

  opt = options.option_parser
  opt.separator nil
  opt.separator "SDoc generator options:"
  opt.separator nil
  opt.on("--github", "-g",
         "Generate links to github.") do |value|
    options.github = true
  end
  opt.separator nil

  opt.on("--no-se-index", "-ns",
         "Do not generated index file for search engines.",
         "SDoc uses javascript to refrence individual documentation pages.",
         "Search engine crawlers are not smart enough to find all the",
         "referenced pages.",
         "To help them SDoc generates a static file with links to every",
         "documentation page. This file is not shown to the user."
         ) do |value|
    options.se_index = false
  end
  opt.separator nil

end

Instance Method Details

#class_dir ⇒ Object 



190
191
192
 
# File 'lib/sdoc/generator.rb', line 190

def class_dir
  CLASS_DIR
end

#file_dir ⇒ Object 



194
195
196
 
# File 'lib/sdoc/generator.rb', line 194

def file_dir
  FILE_DIR
end

#generate(top_levels) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/sdoc/generator.rb', line 175

def generate(top_levels)
  @outputdir = Pathname.new(@options.op_dir).expand_path(@basedir)
  @files = top_levels.sort
  @classes = RDoc::TopLevel.all_classes_and_modules.sort

  # Now actually write the output
  copy_resources
  generate_class_tree
  generate_search_index
  generate_file_files
  generate_class_files
  generate_index_file
  generate_se_index if @options.se_index
end