Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Standalone sdoc generator
Ruby JavaScript

This branch is 25 commits ahead, 136 commits behind voloko:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
.gitignore
.rake_tasks~
LICENSE
README.rdoc
Rakefile
VERSION.yml

README.rdoc

WPDoc

What's in?

  • shtml - RDoc's generator to build searchable documentation

  • sdoc-merge - comand line tool to build merge multiple sdoc documentations packages into a single one

  • sdoc - 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 sdoc --help for more details. --fmt is set to shtml by default. Default template -T is shtml. You can also use 'direct' template. Example: sdoc -o doc/rails -T direct rails

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: sdoc-merge --title "Ruby v1.9, Rails v2.3.2.1" --op merged --names "Ruby,Rails" ruby-v1.9 rails-v2.3.2.1

Something went wrong with that request. Please try again.