[Yaml-core] Re: Generating docs and html?

[why t. l. s. <yam...@wh...>]

Robert Feldt (fe...@ce...) wrote:
> Hi,
> 
> I'm interested in what tools you use to generate the yaml4r.sf.net html
> and docs from yaml sources. Cause that's what you do, eh?
> 

That's correct.  The tools to build my docs are available in the YAML.rb
package.  The tool is called Yod.  You can find yod.rb and take a breeze
through it.  It's very simple.  It currently generates HTML, CHM, and
PDF.  I'm still working on generation of man pages.  PDF generation
currently requires ClibPDF for Ruby.

> I'm thinking of moving all my ruby projects CHANGELOGS, README's etc into
> yaml format and have some standard ways to generate site and docs from
> that... Any pointers?

When you download the YAML.rb package, check out doc/yamlrb.yod.  That
file contains the complete docs.  I also have a script to generate the
class definitions from RDoc.

Once you have a Yod file, here's the script I run in the YAML.rb
directory to generate the various docs:

    #!/usr/local/bin/ruby
    require 'yod'
    y = Yod::load( File.open( 'doc/yamlrb.yod' ) )
    y.to_chm( :MakeAll, 'doc/chm', 'yaml4r' )
    y.to_html( :MakeAll, 'doc/html' )
    y.to_pdf( :Make, 'doc/yamlrb.pdf' )

The `doc/chm' directory will contain the files necessary to build the
CHM.  You'll need to download Microsoft's HTML Help Workshop and compile
it from there.

Perhaps it's time for a page on the YAML.rb site explaining how to use
it all.

_why