[pro] generating documentation

Tamas Papp tkpapp at gmail.com
Tue Jul 19 08:48:46 UTC 2011


Hi,

I am about to complete a revision of LLA and I thought I would write some 
decent documentation.  I have most of the documentation in docstrings, 
though some of general discussions are in ;;; comments in files.

I am looking for a reasonably automatic way of generating documentation 
(eg texinfo or HTML) from the source.  I found many libraries for this on 
cliki, and instead of trying all of them out, I thought I would ask for 
advice here.

Portability would be nice is not necessarily a requirement, so tools like 
sbcl's texinfo are fine too.  However, if possible, I would like to put 
the documentation on the interface and the internal details in separate 
sections somehow.  I would also be interested in including tutorial-like 
sections with examples.

Thanks,

Tamas

PS.: I have searched the cl-pro and c.l.l archives and found some 
discussions about this question, but my impression was that a lot of new 
libraries appeared on the scene in the past few years.





More information about the pro mailing list