Comments on: Offline Gem Server RDocs

By: Ed Schmalzle » Blog Archive » My RDoc Setup

Ed Schmalzle » Blog Archive » My RDoc Setup — Tue, 09 Mar 2010 14:12:40 +0000

[...] I wouldn’t have an always on internet connection to get my documentation fix. I recalled a post by Jason Seifer I had seen that described how to generate your docs with a better template and host [...]

By: Pretty docs for rubygems « Jabberwocky

Pretty docs for rubygems « Jabberwocky — Tue, 01 Dec 2009 20:46:39 +0000

[...] Pretty docs for rubygems Posted in Uncategorized by elisehuard on December 1, 2009 Tip I got through my colleague Bart Duchesne: to have nicer templates for the rubygem documentation, you can use templates. Mislav’s Hanna templates are pretty decent (way better than the default ones anyway). Howto (updated from this site): [...]

By: rogerdpack

rogerdpack — Wed, 24 Jun 2009 01:32:31 +0000

It doesn't indeed [hanna doesn't]

Also note here's a bdoc that has links to external url's, too: http://github.com/rogerdpack/bdoc/tree/master

By: rogerdpack

rogerdpack — Tue, 23 Jun 2009 20:32:31 +0000

It doesn't indeed [hanna doesn't]

Also note here's a bdoc that has links to external url's, too: http://github.com/rogerdpack/bdoc/tree/master

By: roger

roger — Mon, 15 Jun 2009 14:16:44 +0000

does it work with 2.4.3?

By: Marcos Oliveira

Marcos Oliveira — Fri, 24 Apr 2009 04:30:57 +0000

Jason,

Thank you very much. I really needed the local documentation and find all the steps ready here

By: manalang

manalang — Wed, 08 Apr 2009 21:13:40 +0000

Check out Bdoc. It's off-line (really off-line) Rdocs => http://github.com/manalang/bdoc/tree/master

By: Daddy Fixes Everything » Blog Archive » Sinatra-Tailer: a small app for viewing server log files

Wed, 18 Mar 2009 23:03:25 +0000

[...] was reading Jason Seifer’s: Offline Gem Server Rdocs, which is an apache/passenger served Sinatra app that allows you to view the Rdocs of installed [...]

By: almost effortless » Weekly Digest, 3-8-09

almost effortless » Weekly Digest, 3-8-09 — Sun, 08 Mar 2009 17:00:09 +0000

[...] Offline Gem Server RDocs Get Sinatra, Rubygems, and Passenger working for offline RDocs? Count me in. I saw this and new I had to have it. I’ve been on some long plane rides recently and I frequently find myself wanting to look up something from a gem’s documentation while I’m coding. You can use the gem server command but that’s just such a pain to do every time you want to look something up. [...]

By: Ennuyer.net » Blog Archive » Ruby on Rails Link Backlog

Ennuyer.net » Blog Archive » Ruby on Rails Link Backlog — Sat, 28 Feb 2009 13:33:37 +0000

[...] Offline Gem Server RDocs | Jason Seifer [...]

By: Karl

Karl — Sat, 28 Feb 2009 00:10:00 +0000

@Jason,
Well, I have to retreat on my previous comment, it crapped out after about 6 gems with the "--inline-source will be removed from RDoc on or after August 2009" warning, even when not using hanna.

So it looks like it's back to rdoc 2.3.0.

You are right that DarkFish is missing the searchable methods and the dropdown is missing completely. Looks like it forkin' time.

Actually, I like RailsBrain.com docs about the best. Complete navigation via keyboard. Now, how do we get RailsBrain/DarkFish/hanna into the pot for a little rdoc-template stew.

By: jasonseifer

jasonseifer — Fri, 27 Feb 2009 23:31:04 +0000

Hey, thanks a lot. I like the layout of the darkfish template a lot but I couldn't find a way to search by the method names. I'm also not sure how the gem name dropdown looks with that template (or if it even works).

By: Karl

Karl — Fri, 27 Feb 2009 23:26:20 +0000

I had the same issues as k776, as I was on rdoc 2.4.1 as well.

Note1: --inline-source is deprecated as of 2.4.0

Note2: I used 'rdoc: --line-numbers --format=darkfish' in my .gemrc with no problems. Sorry, I just like darkfish better than hanna.

Great idea Jason.

By: jasonseifer

jasonseifer — Fri, 27 Feb 2009 22:54:47 +0000

Thanks a lot for this info. I've updated the post.

By: k776

k776 — Fri, 27 Feb 2009 10:40:13 +0000

It would appear the new Rdoc 2.4.1 doesn't have html format, doesn't support inline source, doesn't support hanna template, and fails on some gems because of opname/op-name. I've downgraded to 2.3.0 and it's working again. Thanks for the article.

By: k776

k776 — Fri, 27 Feb 2009 10:21:22 +0000

No luck with CVS. Even using the ones that are installed doesn't work.

$ sudo gem rdoc –all –no-ri –format=darkfish
ERROR: While executing gem … (OptionParser::InvalidOption)
invalid option: –format=darkfish
$ sudo gem rdoc –all –no-ri –format=ri
ERROR: While executing gem … (OptionParser::InvalidOption)
invalid option: –format=ri

If those work for you, then something is swewd with my setup @_@

By: k776

k776 — Fri, 27 Feb 2009 10:09:36 +0000

/opt/ruby-enterprise-1.8.6-20090201/ and it is in my path, sudo's path, and root users path. All gems are in /opt/ruby-enterprise-1.8.6-20090201/lib/ruby/gems/1.8 . No gems in ~/.gem (I install system wide). Tried uninstall rdoc and hanna, then reinstalling. No luck. Still only giving me ri and darkfish.

By: jasonseifer

jasonseifer — Fri, 27 Feb 2009 10:03:10 +0000

It might be a path issue also. Where is everything installed and is it in your path?

By: k776

k776 — Fri, 27 Feb 2009 10:01:27 +0000

I did, yes. It installed fine too. I'm thinking maybe faulty rdoc install. Grabbing html markup file from rdoc CVS to see how that goes.

By: jasonseifer

jasonseifer — Fri, 27 Feb 2009 09:49:37 +0000

Did you install the hanna gem from above? That's the first thing that I think I can think of that would cause that.