# Stdlib doc - rd2

**URL:** <https://rubytalk.org/t/stdlib-doc-rd2/8418>\
**Category:** ruby-talk\
**Created:** [5 October 2003 15:38 UTC](https://rubytalk.org/t/stdlib-doc-rd2/8418 "2003-10-05T15:38:10Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![Ara.T.Howard1](https://avatars.discourse-cdn.com/v4/letter/a/f19dbf/32.png) [@Ara.T.Howard1](https://rubytalk.org/u/Ara.T.Howard1)\
**Post date:** [5 October 2003 15:38 UTC](https://rubytalk.org/t/stdlib-doc-rd2/8418/1 "2003-10-05T15:38:10Z")

</div>

rubyists-

so, it seems that all the docs in ruby-1.8.0 are in rd format. fine with me.  
has anyone got a script out there to generate docs for all the dist files, not  
that it will be too hard but… i suppose a bettter question is: are the docs  
downloadable anywhere?

if ruby is shipping with rd formatted docs - why not include rd2 (or similar)  
with all dists?

i’m poking around in /usr/local/ruby and my windows dist, but no seeing  
anything obvious…

-a

> **···**
>
> ====================================
> 
> > Ara Howard  
> > NOAA Forecast Systems Laboratory  
> > Information and Technology Services  
> > Data Systems Group  
> > R/FST 325 Broadway  
> > Boulder, CO 80305-3328  
> > Email: [ara.t.howard@noaa.gov](mailto:ara.t.howard@noaa.gov)  
> > Phone: 303-497-7238  
> > Fax: 303-497-7259  
> > The difference between art and science is that science is what we understand  
> > well enough to explain to a computer. Art is everything else.  
> > – Donald Knuth, “Discover”  
> > ~ \> /bin/sh -c ‘for lang in ruby perl; do $lang -e “print "\x3a\x2d\x29\x0a"”; done’  
> > ====================================

---

<div class="post-metadata">

**Author:** ![Austin\_Ziegler2](https://avatars.discourse-cdn.com/v4/letter/a/ad7895/32.png) [@Austin\_Ziegler2](https://rubytalk.org/u/Austin_Ziegler2)\
**Post date:** [5 October 2003 17:08 UTC](https://rubytalk.org/t/stdlib-doc-rd2/8418/2 "2003-10-05T17:08:29Z")

</div>

There is an effort underway to do or redo the stdlib docs in rdoc format.  
I’m not participating it, but it has been talked about on ruby-doc.

-austin

> **···**
>
> On Mon, 6 Oct 2003 00:38:10 +0900, Ara.T.Howard wrote:
> 
> > so, it seems that all the docs in ruby-1.8.0 are in rd format. fine with  
> > me. has anyone got a script out there to generate docs for all the dist  
> > files, not that it will be too hard but… i suppose a bettter question  
> > is: are the docs downloadable anywhere?
> 
> –  
> austin ziegler \* austin@halostatue.ca \* Toronto, ON, Canada  
> software designer \* pragmatic programmer \* 2003.10.05  
> \* 13.06.48

---

<div class="post-metadata">

**Author:** ![Gavin\_Sinclair](https://avatars.discourse-cdn.com/v4/letter/g/db5fbb/32.png) [@Gavin\_Sinclair](https://rubytalk.org/u/Gavin_Sinclair)\
**Post date:** [6 October 2003 00:49 UTC](https://rubytalk.org/t/stdlib-doc-rd2/8418/3 "2003-10-06T00:49:13Z")

</div>

> rubyists-

> so, it seems that all the docs in ruby-1.8.0 are in rd format. fine with me.  
> has anyone got a script out there to generate docs for all the dist files, not  
> that it will be too hard but… i suppose a bettter question is: are the docs  
> downloadable anywhere?

If you’re talking about the documentation for library files, then it’s  
a mix. Some are in RD format, some are in RDoc format, and some are  
not documented. A couple of us are trying to get them all into RDoc  
format.

We’ve done enough of them now that it’s worth pausing to make them  
downloadable. That’s what the recently-created stdlib-doc project is  
for. There’s nothing in the CVS at the moment, but if anyone wants to  
help generate a web page that contains all the available  
documentation, I’d really appreciate it.

What I’m aiming for is a web page that looks like a normal RDoc  
webpage, except that there’s an extra frame on the left side that  
lists all the packages (benchmark, cgi, complex, csv, …). When you  
click one of those, the rest of the page shows the RDoc for that  
package.

Also, there should be a “Conslidated” link that shows RDoc for all  
packages combined.

When I get the project infrastructure set up, I’ll put a task to this  
effect on RubyForge and hope someone bites.

> […]

Cheers,  
Gavin

> **···**
>
> On Monday, October 6, 2003, 1:38:10 AM, Ara.T.Howard wrote:

---

<div class="post-metadata">

**Author:** ![Ara.T.Howard1](https://avatars.discourse-cdn.com/v4/letter/a/f19dbf/32.png) [@Ara.T.Howard1](https://rubytalk.org/u/Ara.T.Howard1)\
**Post date:** [6 October 2003 06:00 UTC](https://rubytalk.org/t/stdlib-doc-rd2/8418/4 "2003-10-06T06:00:14Z")

</div>

gavin-

i am slammed for the next month - but if there are specifice things i could  
contribute to this end, i would like to.

-a

> **···**
>
> On Mon, 6 Oct 2003, Gavin Sinclair wrote:
> 
> > On Monday, October 6, 2003, 1:38:10 AM, Ara.T.Howard wrote:
> > 
> > > rubyists-
> > 
> > > so, it seems that all the docs in ruby-1.8.0 are in rd format. fine with me.  
> > > has anyone got a script out there to generate docs for all the dist files, not  
> > > that it will be too hard but… i suppose a bettter question is: are the docs  
> > > downloadable anywhere?
> > 
> > If you’re talking about the documentation for library files, then it’s  
> > a mix. Some are in RD format, some are in RDoc format, and some are  
> > not documented. A couple of us are trying to get them all into RDoc  
> > format.
> > 
> > We’ve done enough of them now that it’s worth pausing to make them  
> > downloadable. That’s what the recently-created stdlib-doc project is  
> > for. There’s nothing in the CVS at the moment, but if anyone wants to  
> > help generate a web page that contains all the available  
> > documentation, I’d really appreciate it.
> > 
> > What I’m aiming for is a web page that looks like a normal RDoc  
> > webpage, except that there’s an extra frame on the left side that  
> > lists all the packages (benchmark, cgi, complex, csv, …). When you  
> > click one of those, the rest of the page shows the RDoc for that  
> > package.
> > 
> > Also, there should be a “Conslidated” link that shows RDoc for all  
> > packages combined.
> > 
> > When I get the project infrastructure set up, I’ll put a task to this  
> > effect on RubyForge and hope someone bites.
> > 
> > > […]
> > 
> > Cheers,  
> > Gavin
> 
> ====================================
> 
> > Ara Howard  
> > NOAA Forecast Systems Laboratory  
> > Information and Technology Services  
> > Data Systems Group  
> > R/FST 325 Broadway  
> > Boulder, CO 80305-3328  
> > Email: [ara.t.howard@noaa.gov](mailto:ara.t.howard@noaa.gov)  
> > Phone: 303-497-7238  
> > Fax: 303-497-7259  
> > The difference between art and science is that science is what we understand  
> > well enough to explain to a computer. Art is everything else.  
> > – Donald Knuth, “Discover”  
> > ~ \> /bin/sh -c ‘for lang in ruby perl; do $lang -e “print "\x3a\x2d\x29\x0a"”; done’  
> > ====================================
