Method deprecated or moved
This method is deprecated or moved on the latest stable version. The last existing version (v2_2_9) is shown here.
generate_table_of_contents()public
Generate an index page which lists all the classes which are documented.
# File lib/rdoc/generator/darkfish.rb, line 529
def generate_table_of_contents
setup
template_file = @template_dir + 'table_of_contents.rhtml'
return unless template_file.exist?
debug_msg "Rendering the Table of Contents..."
out_file = @outputdir + 'table_of_contents.html'
rel_prefix = @outputdir.relative_path_from out_file.dirname
search_index_rel_prefix = rel_prefix
search_index_rel_prefix += @asset_rel_path if @file_output
# suppress 1.9.3 warning
asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
@title = "Table of Contents - #{@options.title}"
render_template template_file, out_file do |io| binding end
rescue => e
error = RDoc::Error.new "error generating table_of_contents.html: #{e.message} (#{e.class})"
error.set_backtrace e.backtrace
raise error
end Related methods
- Instance methods
- assemble_template
- class_dir
- copy_static
- debug_msg
- file_dir
- gen_sub_directories
- generate
- generate_class
- generate_class_files
- generate_file_files
- generate_index
- generate_page
- generate_servlet_not_found
- generate_servlet_root
- generate_table_of_contents
- get_sorted_module_list
- get_svninfo
- install_rdoc_static_file
- render
- render_template
- setup
- template_for
- template_result
- time_delta_string
- write_style_sheet
- Class methods
- new