Resh

Description

Resh is a HTML template for RDoc.

coderepos.org/share/wiki/Resh

Installation

Archive Installation

        rake install

Gem Installation

        gem install resh

Features/Problems

RubyGems install this to GEMHOME, so raw rdoc command is not able to find ‘resh’. In like this case, use RUBYOPT to load rubygems

        RUBYOPT="-rubygems" rdoc --template resh foobar

Any other gem loaded context, above option is not required.

• Rake::RDocTask

        Rake::RDocTask.new do |rdoc|
                rdoc.rdoc_dir = 'html'
                rdoc.options += RDOC_OPTS
                rdoc.template = "resh"
                if ENV['DOC_FILES']
                        rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,¥s*/))
                else
                        rdoc.rdoc_files.include('README', 'Changelog')
                        rdoc.rdoc_files.include('examples/simple.rb')
                        rdoc.rdoc_files.include('lib/**/*.rb')
                        rdoc.rdoc_files.include('ext/**/*.c')
                end
        end
  

• ~/.gemrc

        rdoc: --template resh
  

Copyright