Forum: Ruby-Gnome 2 Documenting Ruby Suggestions

Announcement (2017-05-07): www.ruby-forum.com is now read-only since I unfortunately do not have the time to support and maintain the forum any more. Please see rubyonrails.org/community and ruby-lang.org/en/community for other Rails- und Ruby-related community platforms.
0d130f179f85401f248e6ebc2ef8292f?d=identicon&s=25 Eric C. (eric_c)
on 2016-06-15 21:55
Hi Y'all

I've been working on documenting visualruby, and I'd like to get some of
feedback of how to document it.

I found a great documenting tool called "yard" that is a great
replacement for rdocs, but it still outputs basically an api looking
document that wouldn't make a great website.

Right now, I'm considering modifying the css to make it more readable,
but I'd really like to find a solution where it generates an actual
website.

Any suggestions?

Eric
0d130f179f85401f248e6ebc2ef8292f?d=identicon&s=25 Eric C. (eric_c)
on 2016-06-16 06:04
I'm making progress on this.  In fact I think I'm happy with it:

http://visualruby.net
0d130f179f85401f248e6ebc2ef8292f?d=identicon&s=25 Eric C. (eric_c)
on 2016-06-18 19:43
I've been working on getting the documentation working.  The "yard" gem
is really valuable.  I hacked the code slightly, and changed some css,
and the website is very functional.  In fact, I'm considering writing a
GUI for yard.

I documented the "Download" page, so everyone can download it, and the
"Signals Tutorial" because its sital to using visualruby.  More to
come...
This topic is locked and can not be replied to.