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