#316 ✓resolved
Jonathan Stott (namelessjon)

Include local rdoc with gems

Reported by Jonathan Stott (namelessjon) | May 27th, 2008 @ 05:51 PM

The 0.9.0 series of gems seems to install no local rdoc.

This makes working with the gems whilst offline rather more difficult than it should be. I quite often run a local gemserver just for looking at the docs, and I quite frequently code without net access (on the train, usually) so a lack of documentation 'to hand' is a problem.

Comments and changes to this ticket

  • Sam Smoot

    Sam Smoot June 2nd, 2008 @ 06:21 PM

    • Assigned user changed from “Sam Smoot” to “Yehuda Katz”

    Right, we use YARD docs. I'll talk to the Merb guys and see how they handle this little hiccup.

  • Adam French

    Adam French June 3rd, 2008 @ 09:09 AM

    argv/lsegal is working on a very awesome branch of YARD which changes up the yard api some

    you could say he's doing some "yard work"...har har

    anyway, one of the things he's done is improve the look and feel of the output documentation. I've tried running this branch against dm-core, but to no avail.

    Will follow up with him on it, though

    http://github.com/lsegal/yard/co...

  • Dan Kubb (dkubb)

    Dan Kubb (dkubb) December 1st, 2008 @ 05:05 PM

    • Tag set to documentation, suggestion
    • State changed from “new” to “hold”
    • Assigned user changed from “Yehuda Katz” to “Jonathan Stott (namelessjon)”

    Jon, is this still a problem? I think the normal rake install process bypasses installing docs just due to speed concerns, however I would have no problem if when the gem is being built if it creates and bundles the docs with it.

  • Jonathan Stott (namelessjon)

    Jonathan Stott (namelessjon) December 4th, 2008 @ 04:27 AM

    • State changed from “hold” to “confirmed”

    A quick survey of the gems server on my lab PC suggests that some of them do. I'm sure my PC at home was different, but that might have had an edge install.

    Still, I will work through the others and make sure they do too.

    Some of the ones that do have rdoc have almost no useful docs contained therein, so I'll see if something quick can be done about that, too.

  • Jonathan Stott (namelessjon)

    Jonathan Stott (namelessjon) December 4th, 2008 @ 10:17 AM

    • State changed from “confirmed” to “resolved”

    All dm-more gems now appear to correctly generate rdoc successfully.

    As previously noted, some work needs to be done on making this more useful, but it is at least there.

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.

New-ticket Create new ticket

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile »

Pages