Paddle 1.0.0 Released

ZOMG. RDOC ON YOUR INTERNET PAD!

FROM THE README!

paddle

DESCRIPTION:

Paddle is an RDoc plugin that emits documentation suitable for use as an
epub
book. The epub book can then be imported to iBooks for reading on iPad!

FEATURES/PROBLEMS:

  • Converts RDoc to epub format
  • Sometimes it doesn’t escape everything properly
  • Links aren’t working yet
  • The tests are poor. Very poor.

SYNOPSIS:

First, make sure to have the latest RDoc. Install paddle, then rdoc
your code
like this:

$ rdoc -o epub -f paddle -t ‘My Documentation’ lib

Next, convert the documentation to an epub file:

$ cd epub
$ zip -Xr9D mydocs.epub mimetype *

Then drag “mydocs.epub” to iTunes, and sync up your iPad.

REQUIREMENTS:

  • RDoc

INSTALL:

  • sudo gem install rdoc

Changes:

1.0.0 / 2010-04-11

  • 1 major enhancement

    • Birthday!

This forum is not affiliated to the Ruby language, Ruby on Rails framework, nor any Ruby applications discussed here.

| Privacy Policy | Terms of Service | Remote Ruby Jobs