= SDoc
== What's in?
- shtml - RDoc's generator to build searchable documentation
- <tt>sdoc-merge</tt> - comand line tool to build merge multiple sdoc documentations
  packages into a single one
- <tt>sdoc</tt> - command line tool to run rdoc with generator=shtml

== Getting Started
    sudo gem install sdoc
    sdoc -N projectdir

== Command line sdoc
sdoc is simply a wrapper to rdoc command line tool. see <tt>sdoc --help </tt>
for more details. <tt>--fmt</tt> is set to shtml by default. 
Default template <tt>-T</tt> is shtml. You can also use 'direct' template.
Example:
<tt>sdoc -o doc/rails -T direct rails</tt>

== Rake
    # Rakefile
    require 'sdoc' # and use your RDoc task the same way you used it before

    Rake::RDocTask.new do |rdoc|
      rdoc.rdoc_dir = 'doc/rdoc'
      rdoc.options << '--fmt' << 'shtml' # explictly set shtml generator
      rdoc.template = 'direct' # lighter template used on railsapi.com
      ...
    end

== sdoc-merge
    Usage: sdoc-merge [options] directories
        -n, --names [NAMES]              Names of merged repositories. Comma separated
        -o, --op [DIRECTORY]             Set the output directory
        -t, --title [TITLE]              Set the title of merged file

Example:
<tt>sdoc-merge --title "Ruby v1.9, Rails v2.3.2.1" --op merged --names "Ruby,Rails" ruby-v1.9 rails-v2.3.2.1</tt>