|
From: | raymond medeiros |
Subject: | Re: [Chicken-users] egg documentation |
Date: | Tue, 12 Feb 2008 23:35:09 -0500 |
basically i was thinking about exactly what rdoc does ( i haven't used mole ) look at rdoc. but then adding the ability to generate wiki code and import it into the svn wiki, and also the ability to generate various formats like pdf's,
html etc... another idea was, in your egg: myegg.wiki which would contain the wiki page, and get imported into svn wiki. that way the maintainer has local control over the document, but it gets automatically imported into the wiki. so you can edit it with VIM or EMACS check it in, and when the egg gets built it updates the appropriate wiki page, entering a new revision using the committers credentials. just my $0.02 in Au On Feb 12, 2008, at 11:10 PM, Ivan Raikov wrote:
Well, there is already mole, but nobody seems to use that. Actually, I tried using it for my very first attempt at creating an egg, but the markup mole supports was quite limited. In general, as much as I admire Donald Knuth and everything he has done for computer science, most attempts at literate programming seem to result in almost unreadable code and documentation that is difficult to maintain. -Ivan Raymond Medeiros <address@hidden> writes:what about something similar to rdoc, inline comments in your code that get parsed out to generate documentation: chicken-doc -to-wiki openssl.egg-dir chicken-doc -to-pdf openssl.egg-dir etc...?
[Prev in Thread] | Current Thread | [Next in Thread] |