# Rdoc and and single file output **URL:** \ **Category:** Ruby\ **Created:** [March 8, 2007, 9:36pm UTC](https://www.ruby-forum.com/t/rdoc-and-and-single-file-output/88198 "2007-03-08T21:36:03Z")\ **Posts on this page:** 8\ **Page:** 1
**Author:** ![danielb](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/c57346/32.png) [@danielb](https://www.ruby-forum.com/u/danielb)\ **Post date:** [March 8, 2007, 9:36pm UTC](https://www.ruby-forum.com/t/rdoc-and-and-single-file-output/88198/1 "2007-03-08T21:36:03Z")
Hi all, Is there a way to generate single file of output for rdoc, creating an html file that mimics the default clicky-clicky multi-frame output, but using css instead of actual frames? I tried using rdoc -1 over one of my files (process.rb, from win32- process, if you’re curious), but it seems to drop a lot of information, and I’m not really sure what it’s supposed to print out. Anyway, it doesn’t suit my needs. My goal is to create single files that I can post on the RubyForge ‘docs’ tab for my projects. Thanks, Dan PS - What would people think of generating a single css tweaked file as the default output for rdoc -1? ---
**Author:** ![danielb](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/c57346/32.png) [@danielb](https://www.ruby-forum.com/u/danielb)\ **Post date:** [March 8, 2007, 9:53pm UTC](https://www.ruby-forum.com/t/rdoc-and-and-single-file-output/88198/2 "2007-03-08T21:53:05Z")
try searching for allison template. it gets rid of the frames and looks very nice. IN fact something like this would do well to include with Rdoc. I almost liked it enough to use myself, but it’s not so good for large projects. ah heck … [http://rubyforge.org/frs/?group\_id=2606](http://rubyforge.org/frs/?group_id=2606) T. ---
**Author:** ![danielb](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/c57346/32.png) [@danielb](https://www.ruby-forum.com/u/danielb)\ **Post date:** [March 8, 2007, 10:02pm UTC](https://www.ruby-forum.com/t/rdoc-and-and-single-file-output/88198/3 "2007-03-08T22:02:07Z")
On Mar 8, 3:52 pm, “Trans” [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote: > try searching for allison template. it gets rid of the frames and > looks very nice. IN fact something like this would do well to include > with Rdoc. I almost liked it enough to use myself, but it’s not so > good for large projects. > > ah heck …[http://rubyforge.org/frs/?group\_id=2606](http://rubyforge.org/frs/?group_id=2606) Noticed the 2.2 version added filters so that makes it better for larger projects than before. I think if some of overly larger header fonts were shrunk a little this would be just about perfect. T. ---
**Author:** ![danielb](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/c57346/32.png) [@danielb](https://www.ruby-forum.com/u/danielb)\ **Post date:** [March 9, 2007, 7:10pm UTC](https://www.ruby-forum.com/t/rdoc-and-and-single-file-output/88198/4 "2007-03-09T19:10:45Z")
On Mar 8, 2:01 pm, “Trans” [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote: > larger projects than before. I think if some of overly larger header > fonts were shrunk a little this would be just about perfect. > > T. Thanks for the link. However, this is a bit too ajaxy for me, and I remember having weird rendering problems with it the last time I tried it. Also, it’s not self contained - it has external href’s, including the css file. I can borrow some ideas from this, however. In other news, using this template appears to have smoked out some warnings in both rdoc and markaby that I’ll report. 🙂 Regards, Dan ---
**Author:** ![danielb](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/c57346/32.png) [@danielb](https://www.ruby-forum.com/u/danielb)\ **Post date:** [March 9, 2007, 8:57pm UTC](https://www.ruby-forum.com/t/rdoc-and-and-single-file-output/88198/5 "2007-03-09T20:57:45Z")
Trans wrote: > larger projects than before. I think if some of overly larger header > fonts were shrunk a little this would be just about perfect. Yeah I agree. I haven’t gotten around to reworking the CSS yet. The Ruby-Cocoa project has a Allison fork with smaller fonts, perhaps you could borrow it from them. Daniel B. wrote: > Thanks for the link. However, this is a bit too ajaxy for me, and I Unless you are going to post-process there is not a good way to avoid the Ajax. RDoc expects frames and only frames. > remember having weird rendering problems with it the last time I tried > it. Like what? > Also, it’s not self contained - it has external href’s, including > the css file. I can borrow some ideas from this, however. Inlining the CSS would be easy enough, but this is how regular RDoc works anyway so I’m not sure what the issue is. The CSS isn’t loaded remotely from some site if that’s what you mean. There aren’t any other includes. If people are expressing interest in Allison, it would motivate me to release a new version. Evan W. ---
**Author:** ![danielb](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/c57346/32.png) [@danielb](https://www.ruby-forum.com/u/danielb)\ **Post date:** [March 9, 2007, 11:45pm UTC](https://www.ruby-forum.com/t/rdoc-and-and-single-file-output/88198/6 "2007-03-09T23:45:27Z")
On Mar 9, 2:57 pm, Evan W. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote: > Inlining the CSS would be easy enough, but this is how regular RDoc > works anyway so I’m not sure what the issue is. The CSS isn’t loaded > remotely from some site if that’s what you mean. There aren’t any other > includes. > > If people are expressing interest in Allison, it would motivate me to > release a new version. I did a little work on it myself so it would be installable (as a gem or via setup.rb). It was simple enough. jsut had to use Dir.tmpdir for the chache folder. Also, it would be nice if it didn’t depend on markaby. Nothing against markaby, it’s just as a rdoc template it would be better if nothing else had to be installed. Thanks, T. ---
**Author:** ![danielb](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/c57346/32.png) [@danielb](https://www.ruby-forum.com/u/danielb)\ **Post date:** [March 10, 2007, 6:20am UTC](https://www.ruby-forum.com/t/rdoc-and-and-single-file-output/88198/7 "2007-03-10T06:20:17Z")
Trans wrote: > On Mar 9, 2:57 pm, Evan W. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote: > Also, it would be nice if it didn’t depend on markaby. Nothing against > markaby, it’s just as a rdoc template it would be better if nothing > else had to be installed. It doesn’t anymore, it uses an included, compiled version of the template if Markaby is not found. You only need Markaby if you want to modify the styles yourself. Evan W. ---
**Author:** ![danielb](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/c57346/32.png) [@danielb](https://www.ruby-forum.com/u/danielb)\ **Post date:** [March 10, 2007, 9:19am UTC](https://www.ruby-forum.com/t/rdoc-and-and-single-file-output/88198/8 "2007-03-10T09:19:42Z")
I wrote: > Ruby-Cocoa project has a Allison fork with smaller fonts, perhaps you Ruby-Cocoa is _also_ working on an Allison fork. But what I had in mind was the work by the RubyObjC group. An example is here: > **[rubyobjc.com](https://www.rubyobjc.com/)** > > Ruby Documentation Project. Documents, links, help, books for the Ruby programming language. Blogtari! powered web site. Evan W.