<div dir="ltr"><div><div><div>Thanks for your hint.<br><br></div>I'll look at that and see what it looks like.<br></div>I am seriously considering the use of "external" documentation system, like a static HTML generator (e.g. emacs org-mode, Pelican) or even simply good'ol LaTeX. Formatting maths would be *so* much easier like that and have a LaTeX to HTML converter in the process, along with PDFs.<br><br></div>Eric<br><br></div><div class="gmail_extra"><br><div class="gmail_quote">2014-11-21 12:00 GMT-05:00  <span dir="ltr"><<a href="mailto:gambit-list-request@iro.umontreal.ca" target="_blank">gambit-list-request@iro.umontreal.ca</a>></span>:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Send Gambit-list mailing list submissions to<br>
        <a href="mailto:gambit-list@iro.umontreal.ca">gambit-list@iro.umontreal.ca</a><br>
<br>
To subscribe or unsubscribe via the World Wide Web, visit<br>
        <a href="https://webmail.iro.umontreal.ca/mailman/listinfo/gambit-list" target="_blank">https://webmail.iro.umontreal.ca/mailman/listinfo/gambit-list</a><br>
or, via email, send a message with subject or body 'help' to<br>
        <a href="mailto:gambit-list-request@iro.umontreal.ca">gambit-list-request@iro.umontreal.ca</a><br>
<br>
You can reach the person managing the list at<br>
        <a href="mailto:gambit-list-owner@iro.umontreal.ca">gambit-list-owner@iro.umontreal.ca</a><br>
<br>
When replying, please edit your Subject line so it is more specific<br>
than "Re: Contents of Gambit-list digest..."<br>
<br>
<br>
Today's Topics:<br>
<br>
   1. Re: Documentation generator for Scheme ? (Hendrik Boom)<br>
<br>
<br>
----------------------------------------------------------------------<br>
<br>
Message: 1<br>
Date: Fri, 21 Nov 2014 09:36:06 -0500<br>
From: Hendrik Boom <<a href="mailto:hendrik@topoi.pooq.com">hendrik@topoi.pooq.com</a>><br>
Subject: Re: [gambit-list] Documentation generator for Scheme ?<br>
To: <a href="mailto:gambit-list@iro.umontreal.ca">gambit-list@iro.umontreal.ca</a><br>
Message-ID: <<a href="mailto:20141121143606.GA21725@topoi.pooq.com">20141121143606.GA21725@topoi.pooq.com</a>><br>
Content-Type: text/plain; charset=us-ascii<br>
<br>
On Wed, Nov 19, 2014 at 04:40:02PM -0500, Hendrik Boom wrote:<br>
> On Wed, Nov 19, 2014 at 03:20:41PM -0500, Eric Parent wrote:<br>
> > Hi all,<br>
> ><br>
> > I'm trying to get documentation being generated automatically based on our<br>
> > Scheme source code. I'm used to work with Doxygen and Sphinx (<br>
> > <a href="http://sphinx-doc.org/index.html" target="_blank">http://sphinx-doc.org/index.html</a>) to generate documentation from C++, C,<br>
> > Python, ... source code files.<br>
> ><br>
> > Is there something equivalent for Scheme ?<br>
><br>
> No idea.  I'd be surprised if there isn't.<br>
><br>
> But the best documentation I've everseen produced by a documentation<br>
> generator is the Trestle Reference Manual, accessible as<br>
> <a href="http://www.hpl.hp.com/techreports/Compaq-DEC/SRC-RR-68.pdf" target="_blank">http://www.hpl.hp.com/techreports/Compaq-DEC/SRC-RR-68.pdf</a><br>
><br>
> It kind of sets a standard to aim for.<br>
<br>
This isn't gambit, but...<br>
<br>
Racket (formerly PLT Scheme) has a text formatter called Scribble.<br>
It appears to be a different concrete syntax for Scheme -- the file is<br>
basically text to be laid out properly interrupted by @ signs that can<br>
be followed by arious codes, including complete Scheme expressions.<br>
In those expressions you can use Schee as an ordinary programming<br>
language, but you also have access to a slew of text-formatting<br>
functions.<br>
<br>
Their packaging system has, I believe, some conventions about how to<br>
embed Scribble code amongst the normal Scheme, so that some program<br>
they have can extract some documentation.<br>
<br>
I don't know the details, and I don't know if it will satisfy your<br>
needs, but it is worth a look.  You might be able to use Racket to<br>
extract documentation from your Gambit code.<br>
<br>
It may be worth porting some of this stuff to Gambit.<br>
<br>
-- hendrik<br>
<br>
<br>
------------------------------<br>
<br>
_______________________________________________<br>
Gambit-list mailing list<br>
<a href="mailto:Gambit-list@iro.umontreal.ca">Gambit-list@iro.umontreal.ca</a><br>
<a href="https://webmail.iro.umontreal.ca/mailman/listinfo/gambit-list" target="_blank">https://webmail.iro.umontreal.ca/mailman/listinfo/gambit-list</a><br>
<br>
<br>
End of Gambit-list Digest, Vol 122, Issue 4<br>
*******************************************<br>
</blockquote></div><br><br clear="all"><br>-- <br><div class="gmail_signature"><div dir="ltr">Eric<br></div></div>
</div>