From: james a. <jam...@se...> - 2003-03-06 22:58:48
|
hello; i heard a rumor that you use docbook for your documentation. i'm looking for a "reasonable" format for a encoding for system documentation. i rummaged through your release and observe that your docbook use appears to be restricted to hand-coded sgml. for instance, i found nothing in the release which uses the documentation function. has there been any work on generating the system documentation from the source? thanks. ... |
From: Paolo A. <am...@mc...> - 2003-03-07 12:58:05
|
On Thu, 6 Mar 2003 23:58:29 +0100, James Anderson wrote: > i heard a rumor that you use docbook for your documentation. i'm The manual of Pierre Mai's MaiSQL(sp?) is based on a version of DocBook tweaked to the needs of Lisp documentation. Paolo -- Paolo Amoroso <am...@mc...> |
From: William H. N. <wil...@ai...> - 2003-03-07 14:44:00
|
On Thu, Mar 06, 2003 at 11:58:29PM +0100, james anderson wrote: > i heard a rumor that you use docbook for your documentation. i'm > looking for a "reasonable" format for a encoding for system > documentation. i rummaged through your release and observe that your > docbook use appears to be restricted to hand-coded sgml. for instance, > i found nothing in the release which uses the documentation function. > has there been any work on generating the system documentation from the > source? You're right, we use DocBook for the system manual, and we don't have any special mechanism for generating DocBook-formatted text automatically from the .lisp source files. -- William Harold Newman <wil...@ai...> "Build a man a fire, and he'll be warm for a day. Set a man on fire, and he'll be warm for the rest of his life." -- Terry Pratchett PGP key fingerprint 85 CE 1C BA 79 8D 51 8C B9 25 FB EE E0 C3 E5 7C |
From: Christophe R. <cs...@ca...> - 2003-03-07 14:49:40
|
William Harold Newman <wil...@ai...> writes: > On Thu, Mar 06, 2003 at 11:58:29PM +0100, james anderson wrote: > > i heard a rumor that you use docbook for your documentation. i'm > > looking for a "reasonable" format for a encoding for system > > documentation. i rummaged through your release and observe that your > > docbook use appears to be restricted to hand-coded sgml. for instance, > > i found nothing in the release which uses the documentation function. > > has there been any work on generating the system documentation from the > > source? > > You're right, we use DocBook for the system manual, and we don't have > any special mechanism for generating DocBook-formatted text > automatically from the .lisp source files. That said, I believe there is something in db-sockets (which has mutated into the sb-bsd-sockets contrib in the SBCL sources) that does do some kind of introspective analysis of its source and symbols... I don't know if the code to do that persists in our CVS, but maybe Dan can say something about that? Cheers, Christophe -- http://www-jcsu.jesus.cam.ac.uk/~csr21/ +44 1223 510 299/+44 7729 383 757 (set-pprint-dispatch 'number (lambda (s o) (declare (special b)) (format s b))) (defvar b "~&Just another Lisp hacker~%") (pprint #36rJesusCollegeCambridge) |
From: Daniel B. <da...@te...> - 2003-03-07 17:20:59
|
Christophe Rhodes <cs...@ca...> writes: > That said, I believe there is something in db-sockets (which has > mutated into the sb-bsd-sockets contrib in the SBCL sources) that does > do some kind of introspective analysis of its source and symbols... I > don't know if the code to do that persists in our CVS, but maybe Dan > can say something about that? It's still there, but it doesn't actually run as part of the default build. Look at doc.lisp - output is in index.html * It needs asdf: first it loads a system, then it reads all the files in it. * It currently generates HTML, not DocBook * It reads #| |# comments, which it includes verbatim in the output * It converts methods, functions, classes, and some other forms into HTML, attempting to do clever things like make hyperlinks out of ALL-CAPS words in doc strings * It's more than a little bit kludgey -dan -- http://www.cliki.net/ - Link farm for free CL-on-Unix resources |