Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Standalone sdoc generator
CSS JavaScript Ruby

This branch is 67 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.md
Rakefile
sdoc.gemspec

README.md

SDoc

Powering http://api.rubyonrails.org/ and http://railsapi.com/

What is sdoc?

RDoc generator to build searchable HTML documentation for Ruby code.

  • sdoc - command line tool to run rdoc with generator=shtml (searchable HTML)
  • sdoc-merge - command line tool to merge multiple sdoc folders into a single documentation site

Getting Started

  # Install the gem
  gem install sdoc

  # Generate documentation for 'projectdir'
  sdoc projectdir

sdoc

sdoc is simply a wrapper for the rdoc command line tool. See sdoc --help for more details. --fmt is set to shtml by default. The default template -T is shtml, but you can also use the direct template.

Example:

sdoc -o doc/rails -T direct rails

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

Rake Task

# 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

Who?

Something went wrong with that request. Please try again.