[racket] Generating docs

From: Mark Carter (mcturra2000 at yahoo.co.uk)
Date: Thu Apr 7 07:30:03 EDT 2011

I'm still quite puzzled as to how to document my modules.

I have a directory called "carali", which contains rkt files. One of the files 
is http.rkt, containing the code:
(module maths racket
  (provide http-get)
 (require racket/port)
  (require net/url)
(require scribble/srcdoc)

(provide/doc (proc-doc/names
              http-get
              (-> string?)
              (url-as-string)
              @{Say something meaningfil about http-get}))

(define (http-get url-as-string)
  (port->string (get-pure-port (string->url url-as-string))))

In my ~/src/racket-5.1/collects dir, I have a link to my carali dir. 

So, how do I get my carali module docs to be visible to DrRacket? I can actually 
use the module, but the docs don't yet work. Do I have to generate the docs 
manually, and if so how? Are there any special files that I also have to 
document, like info.rkt or main.rkt?




Posted on the users mailing list.