Flowdock
class
Importance_2
v2_1_10 - Show latest stable - 0 notes - Superclass: Object

Darkfish RDoc HTML Generator

$Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $

Author/s

  • Michael Granger (ged@FaerieMUD.org)

Contributors

  • Mahlon E. Smith (mahlon@martini.nu)

  • Eric Hodel (drbrain@segment7.net)

License

Copyright © 2007, 2008, Michael Granger. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the author/s, nor the names of the project’s contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Attributions

Darkfish uses the Silk Icons set by Mark James.

Constants

SVNID_PATTERN = / \$Id:\s (\S+)\s # filename (\d+)\s # rev (\d{4}-\d{2}-\d{2})\s # Date (YYYY-MM-DD) (\d{2}:\d{2}:\d{2}Z)\s # Time (HH:MM:SSZ) (\w+)\s # committer \$$ /x

DESCRIPTION = 'HTML generator, written by Michael Granger'

VERSION = '3'

GENERATOR_DIR = File.join 'rdoc', 'generator'

BUILTIN_STYLE_ITEMS = # :nodoc: %w[ fonts.css fonts/Lato-Light.ttf fonts/Lato-LightItalic.ttf fonts/Lato-Regular.ttf fonts/Lato-RegularItalic.ttf fonts/SourceCodePro-Bold.ttf fonts/SourceCodePro-Regular.ttf rdoc.css ]

Attributes

[R] outputdir

The output directory

[R] template_dir

The directory where the template files live

[R] store

The RDoc::Store that is the source of the generated content

[R] modsort

Sorted list of classes and modules to be displayed by this generator

[R] methods

Methods to be displayed by this generator

[R] json_index

The JSON index generator for this Darkfish generator

[R] files

Files to be displayed by this generator

[RW] file_output

When false the generate methods return a String instead of writing to a file. The default is true.

[RW] dry_run

No files will be written when dry_run is true.

[R] classes

Classes and modules to be used by this generator, not necessarily displayed. See also #modsort

[R] base_dir

The path to generate files into, combined with --op from the options for a full path.

[RW] asset_rel_path

The relative path to style sheets and javascript. By default this is set the same as the rel_prefix.

Show files where this class is defined (1 file)
Register or log in to add new notes.