Rdoc and and single file output


#1

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?


#2

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

T.


#3

On Mar 8, 3:52 pm, “Trans” 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

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.


#4

On Mar 8, 2:01 pm, “Trans” 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. :slight_smile:

Regards,

Dan


#5

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.


#6

On Mar 9, 2:57 pm, Evan W. 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.


#7

Trans wrote:

On Mar 9, 2:57 pm, Evan W. 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.


#8

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:
http://www.rubyobjc.com/doc/classes/ObjC/Method.html

Evan W.