[plt-scheme] Scribble and source code documentation?

From: Noel Welsh (noelwelsh at gmail.com)
Date: Thu Jun 14 05:18:01 EDT 2007

On 6/13/07, Grant Rettke <grettke at acm.org> wrote:
> Is this a competitor to slatex?

In a sense yes, but I think Scribble will end up with different uses to slatex.

Slatex allows you to embed Scheme code in Latex documents and get nice
output in the formats Latex supports PS, PDF.  Using tex2page you can
produce fairly rigid (though very nice!) HTML from a slatex document.

Scribble lets your write documentation in Scheme (Scribble is just a
special Scheme syntax) and render to a variety of formats, including
Latex (presumably using Slatex, though I haven't checked).  It gives
you more control over the output (new rendering engines are easier to
write) and is more comfortable than Latex for a Schemer.

People writing academic publications will still use (s)latex as every
conference in CS uses it.

People writing (PLT) Scheme-related docs that will find their way onto
the web will probably want to use Scribble.

> Is there a way to use Scribble to do source code documentation?

Do you mean to embed Scribble documentation in the same file as code?
There is no system in place, but it would be the work of a few hours
to make one, if you don't want the Scribble syntax.


Posted on the users mailing list.