RDoc status and future?
in [Ruby]
|
Prev: How to turn $10 into $10,000 fast! 21
Next: Performance of Ruby 1.9 vs. Ruby 1.8 (was: Speed sprint)
From: Claus Folke Brobak on 23 Feb 2010 05:11 Hi all, RDoc 1.0.1 is part of the standard library for Ruby 1.8.6 and 1.8.7 (don't know about Ruby 1.9.x). RDoc 2.4.3 seems to be the newest and very different version but is not part of the standard library. Can anyone shed some light on the status and future of RDoc as the standard way of documenting Ruby programs? Has development of RDoc stopped? What do you use for generating documentation of your Ruby programs? Best regards, Claus -- Posted via http://www.ruby-forum.com/.
From: Intransition on 23 Feb 2010 11:47 On Feb 23, 5:11 am, Claus Folke Brobak <c...(a)jndata.dk> wrote: > Hi all, > > RDoc 1.0.1 is part of the standard library for Ruby 1.8.6 and 1.8.7 > (don't know about Ruby 1.9.x). > > RDoc 2.4.3 seems to be the newest and very different version but is not > part of the standard library. > > Can anyone shed some light on the status and future of RDoc as the > standard way of documenting Ruby programs? > Has development of RDoc stopped? > What do you use for generating documentation of your Ruby programs? I use RDoc 2.4.3 but via WebRI. Others use Yard.
From: Claus Folke Brobak on 24 Feb 2010 04:14 Thomas Sawyer wrote: > On Feb 23, 5:11�am, Claus Folke Brobak <c...(a)jndata.dk> wrote: >> Has development of RDoc stopped? >> What do you use for generating documentation of your Ruby programs? > > I use RDoc 2.4.3 but via WebRI. Others use Yard. Generally, I am worried about the future of RDoc: - Will RDoc continue to be part of the Ruby Standard Library? - Is RDoc still actively developed? - RDoc future plans? - Why are people starting to use YARD? I am working for a company and we cannot just switch documentation tool from one project to the next, so I am really looking for some degree of assurance that we are using the right tool. Preferably a tool which is part of the Ruby Standard Library. Claus -- Posted via http://www.ruby-forum.com/.
From: Arndt Roger Schneider on 24 Feb 2010 06:10 Claus Folke Brobak schrieb: >Thomas Sawyer wrote: > > >>On Feb 23, 5:11�am, Claus Folke Brobak <c...(a)jndata.dk> wrote: >> >> >>>Has development of RDoc stopped? >>>What do you use for generating documentation of your Ruby programs? >>> >>> >>I use RDoc 2.4.3 but via WebRI. Others use Yard. >> >> > >Generally, I am worried about the future of RDoc: > >- Will RDoc continue to be part of the Ruby Standard Library? >- Is RDoc still actively developed? >- RDoc future plans? >- Why are people starting to use YARD? > >I am working for a company and we cannot just switch documentation tool >from one project to the next, so I am really looking for some degree of >assurance that we are using the right tool. Preferably a tool which is >part of the Ruby Standard Library. > >Claus > > Then make yourself independent from language specific, html documentation tools. I am using docbook in Jeszra. Jeszra also generates RDoc (pydoc) comments, when creating ruby (python) classes. Here is an overview of DocBook generation in Jeszra: http://jeszra.sourceforge.net/jeszra/Jeszra_DocBook.html The end-structur of a Docbook document (or DITA as an alternative) is controlled by your docbook toolchain --the main workload for tools such as RDoc. Converting the RDoc comments into a docbook document is simple in comparision to the structur generation part in RDoc. So use the RDoc tags to make Docbook documents from them. -roger
From: Ryan Davis on 24 Feb 2010 06:57
On Feb 24, 2010, at 01:14 , Claus Folke Brobak wrote: > Thomas Sawyer wrote: >> On Feb 23, 5:11�am, Claus Folke Brobak <c...(a)jndata.dk> wrote: >>> Has development of RDoc stopped? >>> What do you use for generating documentation of your Ruby programs? >> >> I use RDoc 2.4.3 but via WebRI. Others use Yard. > > Generally, I am worried about the future of RDoc: > > - Will RDoc continue to be part of the Ruby Standard Library? absolutely > - Is RDoc still actively developed? Rdoc is alive and well. It is maintained by Eric Hodel. The gem is far beyond what ships in 1.8. 1.9 ships a couple revs behind the gem. > - RDoc future plans? Eric's latest sprint was to improve the rdoc parser so it was much faster, lighter on memory, and thoroughly tested. I don't know what else he has in mind for it at this time. > - Why are people starting to use YARD? good question. |