Skip to content

Instantly share code, notes, and snippets.

@prusswan
Last active December 18, 2015 01:19
Show Gist options
  • Save prusswan/5703074 to your computer and use it in GitHub Desktop.
Save prusswan/5703074 to your computer and use it in GitHub Desktop.
Ruby and Rails offline docs generation
# rails
sdoc -x test -x example -x bin -N --main rails-3.2.13/README.rdoc --title "Rails 3.2.13" --op ~/Desktop/rails-3.2.13 rails-3.2.13
# ruby (rbenv)
sdoc --main ruby-1.9.3-p392/README -x test -x example -x bin -N --title "Ruby 1.9.3" --op ~/Desktop/ruby-1.9.3 ~/.rbenv/sources/1.9.3-p392/ruby-1.9.3-p392 ~/.rbenv/sources/1.9.3-p392/ruby-1.9.3-p392/README
sdoc --main ruby-1.9.3-p392/README -x test -x example -x bin -N --title "Ruby 1.9.3" --op ~/Desktop/ruby-1.9.3 ruby-1.9.3-p392 ruby-1.9.3-p392/README
# not working yet
sdoc --main ruby-2.0.0-p195/README -x test -x example -x bin -N --title "Ruby 2.0.0" --op ~/Desktop/ruby-2.0.0 ~/.rbenv/sources/2.0.0-p195/ruby-2.0.0-p195 ~/.rbenv/sources/2.0.0-p195/ruby-2.0.0-p195/README
# merge
sdoc-merge --title "Ruby 1.9.3, Rails 3.2.13" --op merged --names "Ruby 1.9.3,Rails 3.2.13" ruby-1.9.3 rails-3.2.13
@gamov
Copy link

gamov commented Feb 25, 2014

you should do -x |/test$ instead of -x test so assertions show up.

As of 26.2.2014, see those two issues:
rails/sdoc#71
rails/sdoc#72

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment