Rdoc hosting?

Ruby
1

Hi,
I’ve started using GitHub and I really liked the idea of the rdoc.info
web-hook (which generated ruby documentation after every commit). The
problem is that I thought rdoc.info was actually for RDoc documentation,
but it’s for YARD.
Do any of you know of a similar server which could host RDoc
documentation? Or any simple and free hosting service that would let me
publish rdoc’s html files with a web-hook from github?

Thanks

2

On Feb 28, 2010, at 14:42, Matt B. wrote:

I’ve started using GitHub and I really liked the idea of the rdoc.info
web-hook (which generated ruby documentation after every commit). The
problem is that I thought rdoc.info was actually for RDoc documentation,
but it’s for YARD.
Do any of you know of a similar server which could host RDoc
documentation? Or any simple and free hosting service that would let me
publish rdoc’s html files with a web-hook from github?

I’ve been trying to get rdoc.com or rdoc.net for that purpose, but
they’re domain squatted for outrageous prices.

3

Eric H. wrote:

On Feb 28, 2010, at 14:42, Matt B. wrote:

I’ve started using GitHub and I really liked the idea of the rdoc.info
web-hook (which generated ruby documentation after every commit). The
problem is that I thought rdoc.info was actually for RDoc documentation,
but it’s for YARD.
Do any of you know of a similar server which could host RDoc
documentation? Or any simple and free hosting service that would let me
publish rdoc’s html files with a web-hook from github?

I’ve been trying to get rdoc.com or rdoc.net for that purpose, but
they’re domain squatted for outrageous prices.

Well, if it is just a matter of domain availability I think there are
plenty of services available for subdomains under an acceptable domain
(as dyndns used to offer, but I think now it displays ads).

4

On Mar 1, 2010, at 16:30, Matt B. wrote:
Eric H. wrote:

they’re domain squatted for outrageous prices.

Well, if it is just a matter of domain availability I think there are
plenty of services available for subdomains under an acceptable domain
(as dyndns used to offer, but I think now it displays ads).

Maybe rdoc.rubygems.org? I already have control of DNS there…

5

Thomas S. wrote:

On Feb 28, 5:42�pm, Matt B. [email protected] wrote:

Hi,
I’ve started using GitHub and I really liked the idea of the rdoc.info
web-hook (which generated ruby documentation after every commit). The
problem is that I thought rdoc.info was actually for RDoc documentation,
but it’s for YARD.
Do any of you know of a similar server which could host RDoc
documentation? Or any simple and free hosting service that would let me
publish rdoc’s html files with a web-hook from github?

You can host your RDoc on GitHub. Just generate your rdocs to a
project directory --I use doc/rdoc/, then use the grancher gem to push
them to a gh-pages branch. If you want to have a website too, say in
the site/ directory, then ln -s …/doc/rdoc site/rdoc, and add an in your webpage. And use grancher on the site/ directory
instead. Your rdoc will be available at
http://youraccount.github.com/yourproject/rdoc.

Well, that’s good to know. In any case, what I liked about the service
hook is that you don’t need to remember to update the documentation
manually every time.
Also, for some reason, my project’s page never gets published, so I
can’t rely on that (my user page is publish though).

Maybe for the time being I’ll use rdoc.info (since actually YARD is
kinda compatible with RDoc comments, but not fully) for that reason.

6

On Mar 1, 2010, at 18:39 , Matt B. wrote:

Well, that’s good to know. In any case, what I liked about the service
hook is that you don’t need to remember to update the documentation
manually every time.

hoe also automatically publishes every time you release as well…

Add “publish_on_announce: true” to your .hoerc and you’re set.

7

On Feb 28, 5:42 pm, Matt B. [email protected] wrote:

Hi,
I’ve started using GitHub and I really liked the idea of the rdoc.info
web-hook (which generated ruby documentation after every commit). The
problem is that I thought rdoc.info was actually for RDoc documentation,
but it’s for YARD.
Do any of you know of a similar server which could host RDoc
documentation? Or any simple and free hosting service that would let me
publish rdoc’s html files with a web-hook from github?

You can host your RDoc on GitHub. Just generate your rdocs to a
project directory --I use doc/rdoc/, then use the grancher gem to push
them to a gh-pages branch. If you want to have a website too, say in
the site/ directory, then ln -s …/doc/rdoc site/rdoc, and add an in your webpage. And use grancher on the site/ directory
instead. Your rdoc will be available at
http://youraccount.github.com/yourproject/rdoc.

8

Dreamcat F. wrote:

Jewler could hide the generated docs away in its cache directory and
automate the process through a rake task. And include the gh-pages push
in jeweler’s “rake release” task.

It would ensure the documentation is always in sync with whats released
to gemcutter.

That would be terrific.

9

Matt B. wrote:

Thomas S. wrote:

On Feb 28, 5:42�pm, Matt B. [email protected] wrote:

Well, that’s good to know. In any case, what I liked about the service
hook is that you don’t need to remember to update the documentation
manually every time.
Also, for some reason, my project’s page never gets published, so I
can’t rely on that (my user page is publish though).

Maybe for the time being I’ll use rdoc.info (since actually YARD is
kinda compatible with RDoc comments, but not fully) for that reason.

That hoe suggestion was good. Although Jeweler has grown to be more
popular than hoe for new work. So maybe we should also add this
functionality into the jeweler gem. Grancher + yardoc/rdoc generation.

Jewler could hide the generated docs away in its cache directory and
automate the process through a rake task. And include the gh-pages push
in jeweler’s “rake release” task.

It would ensure the documentation is always in sync with whats released
to gemcutter.

dreamcat4
[email protected]