ANN: Ruby Standard Library Documentation, v0.9.0

ruby-talk
1

Hi folks,

I’ve bumped the version of the documentation available at

http://www.ruby-doc.org/stdlib/

to reflect the following major changes:

  • All major Ruby libraries now included (added xsd, wsdl, etc).

  • All ‘ext’ C-coded standard libraries added (none were there
    before). This includes things like curses, dbm, openssl, stringio,
    and so on. They are not documented, but their very addition is a
    significant step forward (i.e. at least you can browse the
    methods).

Cheers,
Gavin

2

Gavin Sinclair wrote:

Hi folks,

I’ve bumped the version of the documentation available at

RDoc Documentation

to reflect the following major changes:

  • All major Ruby libraries now included (added xsd, wsdl, etc).

  • All ‘ext’ C-coded standard libraries added (none were there
    before). This includes things like curses, dbm, openssl, stringio,
    and so on. They are not documented, but their very addition is a
    significant step forward (i.e. at least you can browse the
    methods).

Cheers,
Gavin

On the [source] popdowns. Would it be too much to ask to change the
color of the comments to yellow? I cannot see the red on black very well
at all. Yes, I am colorblind. : )

3

one minor bug:
generator.rb seems to have something wrong with the rd decodnig. I
don’t think that “== Overview” should appear :slight_smile:

plus, at 800x600 resolution the text goes out of the gray box, but I
agree that there are little users with this resolution :wink:

···

il Thu, 12 Feb 2004 23:09:03 +0900, Gavin Sinclair gsinclair@soyabean.com.au ha scritto::

Hi folks,

I’ve bumped the version of the documentation available at

RDoc Documentation

to reflect the following major changes:

4

Gavin Sinclair wrote:

Hi folks,

I’ve bumped the version of the documentation available at

http://www.ruby-doc.org/stdlib/

to reflect the following major changes:

  • All major Ruby libraries now included (added xsd, wsdl, etc).

  • All ‘ext’ C-coded standard libraries added (none were there
    before). This includes things like curses, dbm, openssl, stringio,
    and so on. They are not documented, but their very addition is a
    significant step forward (i.e. at least you can browse the
    methods).

Cheers,
Gavin

On the [source] popdowns. Would it be too much to ask to change the
color of the comments to yellow? I cannot see the red on black very well
at all. Yes, I am colorblind. : )

Good idea. I’ll see if I can work out how to do it. There are some CSS
changes I want to make in general, but it’s pretty involved…

Gavin

5

Gavin Sinclair wrote:

Hi folks,
I’ve bumped the version of the documentation available at
http://www.ruby-doc.org/stdlib/
to reflect the following major changes:

  • All major Ruby libraries now included (added xsd, wsdl, etc).
  • All ‘ext’ C-coded standard libraries added (none were there
    before). This includes things like curses, dbm, openssl, stringio,
    and so on. They are not documented, but their very addition is a
    significant step forward (i.e. at least you can browse the
    methods).
    Cheers,
    Gavin

This is looking fantastic. Thanks to everyone involved for all the
great work.

Any chance of allowing anon cvs access as well as download?

6

Hi folks,

I’ve bumped the version of the documentation available at

http://www.ruby-doc.org/stdlib/

to reflect the following major changes:

one minor bug:
generator.rb seems to have something wrong with the rd decodnig. I
don’t think that “== Overview” should appear :slight_smile:

Thanks. Fixed in next release.

plus, at 800x600 resolution the text goes out of the gray box, but I
agree that there are little users with this resolution :wink:

Yeah, you can’t please everyone :slight_smile:

Gavin

···

On Saturday, February 14, 2004, 12:34:54 PM, gabriele wrote:

il Thu, 12 Feb 2004 23:09:03 +0900, Gavin Sinclair > gsinclair@soyabean.com.au ha scritto::

7

Gavin Sinclair wrote:

Gavin Sinclair wrote:

Hi folks,

I’ve bumped the version of the documentation available at

RDoc Documentation

to reflect the following major changes:

  • All major Ruby libraries now included (added xsd, wsdl, etc).

  • All ‘ext’ C-coded standard libraries added (none were there
    before). This includes things like curses, dbm, openssl, stringio,
    and so on. They are not documented, but their very addition is a
    significant step forward (i.e. at least you can browse the
    methods).

Cheers,
Gavin

On the [source] popdowns. Would it be too much to ask to change the
color of the comments to yellow? I cannot see the red on black very well
at all. Yes, I am colorblind. : )

Good idea. I’ll see if I can work out how to do it. There are some CSS
changes I want to make in general, but it’s pretty involved…

Gavin

I would much appreciate it because those docs are now bookmarked for
heavy usage! : )

8

That was my original intention, but there are SOOOOOO MANY files
(lemme see … 3223 at present) that I think CVS is not really up to
it.

If you want to be at the bleeding edge, you can generate the docs from
the Ruby source yourself. That enables you to choose the absolute
latest code, or the 1.6.x code, or whatever. (The website shows the
latest 1.8 code.) I’m happy to assist you in setting that up; it is
meant to be easy.

In practical terms, though, I just suggest the following:

  • download the docs at some point
  • keep an eye on the history to see what’s been added
  • when enough things have been added that you want the latest,
    download it

The tarball is still < 2MB. I’m thinking of removing the ZIP at > 4MB.

Cheers,
Gavin

···

On Saturday, February 14, 2004, 8:44:30 AM, J.Herre wrote:

Gavin Sinclair wrote:

Hi folks,
I’ve bumped the version of the documentation available at
RDoc Documentation
to reflect the following major changes:

  • All major Ruby libraries now included (added xsd, wsdl, etc).
  • All ‘ext’ C-coded standard libraries added (none were there
    before). This includes things like curses, dbm, openssl, stringio,
    and so on. They are not documented, but their very addition is a
    significant step forward (i.e. at least you can browse the
    methods).
    Cheers,
    Gavin

This is looking fantastic. Thanks to everyone involved for all the
great work.

Any chance of allowing anon cvs access as well as download?

9

Remember you can download and install them for offline viewing, which
is much faster. And you can still bookmark the page; future installs
will overwrite the existing one.

Gavin

···

On Friday, February 13, 2004, 11:04:56 PM, Robert wrote:

Gavin Sinclair wrote:

Gavin Sinclair wrote:

Hi folks,

I’ve bumped the version of the documentation available at

RDoc Documentation

to reflect the following major changes:

  • All major Ruby libraries now included (added xsd, wsdl, etc).

  • All ‘ext’ C-coded standard libraries added (none were there
    before). This includes things like curses, dbm, openssl, stringio,
    and so on. They are not documented, but their very addition is a
    significant step forward (i.e. at least you can browse the
    methods).

Cheers,
Gavin

On the [source] popdowns. Would it be too much to ask to change the
color of the comments to yellow? I cannot see the red on black very well
at all. Yes, I am colorblind. : )

Good idea. I’ll see if I can work out how to do it. There are some CSS
changes I want to make in general, but it’s pretty involved…

Gavin

I would much appreciate it because those docs are now bookmarked for
heavy usage! : )

10

I’ve tinkered with using rdoc on the stdlib but the results aren’t as
pretty as yours. Also the master index on the left is a big help.

It’d be great to have the option of generating the docs myself. Maybe
you could also offer a mini distribution that has everything thing you
need to build it yourself from a ruby source tree?

Thanks,

-J

···

On Feb 13, 2004, at 2:29 PM, Gavin Sinclair wrote:

If you want to be at the bleeding edge, you can generate the docs from
the Ruby source yourself. That enables you to choose the absolute
latest code, or the 1.6.x code, or whatever. (The website shows the
latest 1.8 code.) I’m happy to assist you in setting that up; it is
meant to be easy.

11

Gavin Sinclair wrote:

···

On Friday, February 13, 2004, 11:04:56 PM, Robert wrote:

Gavin Sinclair wrote:

Gavin Sinclair wrote:

Hi folks,

I’ve bumped the version of the documentation available at

RDoc Documentation

to reflect the following major changes:

  • All major Ruby libraries now included (added xsd, wsdl, etc).

  • All ‘ext’ C-coded standard libraries added (none were there
    before). This includes things like curses, dbm, openssl, stringio,
    and so on. They are not documented, but their very addition is a
    significant step forward (i.e. at least you can browse the
    methods).

Cheers,
Gavin

On the [source] popdowns. Would it be too much to ask to change the
color of the comments to yellow? I cannot see the red on black very well
at all. Yes, I am colorblind. : )

Good idea. I’ll see if I can work out how to do it. There are some CSS
changes I want to make in general, but it’s pretty involved…

Gavin

I would much appreciate it because those docs are now bookmarked for
heavy usage! : )

Remember you can download and install them for offline viewing, which
is much faster. And you can still bookmark the page; future installs
will overwrite the existing one.

Gavin

I just saw that. Very cool too.

12

That would be http://stdlib-doc.rubyforge.org :slight_smile: (CVS only)

I think the instructions are reasonably clear. I’ll help you through
it anyway to make sure they are. Summary:

  1. Edit the etc/cfg/stdlib-doc.yaml file to point to the source dir

  2. ruby stdlib-doc.rb gendoc --all

That should be it, really.

Cheers,
Gavin

···

On Saturday, February 14, 2004, 9:58:56 AM, J.Herre wrote:

On Feb 13, 2004, at 2:29 PM, Gavin Sinclair wrote:

If you want to be at the bleeding edge, you can generate the docs from
the Ruby source yourself. That enables you to choose the absolute
latest code, or the 1.6.x code, or whatever. (The website shows the
latest 1.8 code.) I’m happy to assist you in setting that up; it is
meant to be easy.

I’ve tinkered with using rdoc on the stdlib but the results aren’t as
pretty as yours. Also the master index on the left is a big help.

It’d be great to have the option of generating the docs myself. Maybe
you could also offer a mini distribution that has everything thing you
need to build it yourself from a ruby source tree?