[racket] inline source documentation->html tool for Racket? (like Pydoc or Javadoc?)

From: Matthias Felleisen (matthias at ccs.neu.edu)
Date: Mon Jul 1 16:42:33 EDT 2013

1. For now you may wish to look up 




This is not exactly javadoc but it does allow you to combine documentation with the module itself as opposed to a separate file. 

2. Consider scribble/lp as an alternative, keeping the lp part to a minimum. 

3. One day soon you may see (define come with parts that allow in-line documentation. 

;; --- 

Scribble is superior to javadoc and Matthew/Eli/Robby wrote an entire paper on why that is. But I understand that if you are used to certain tools, you may wish to stick to those tools until you're comfortable using better things. 

-- Matthias


On Jul 1, 2013, at 2:11 PM, Christopher <ultimatemacfanatic at gmail.com> wrote:

> Hey all,
> Is there an inline source documentation to HTML tool for Racket?  I want to document my Racket module functions and classes and variables in the .rkt file and then run it through a tool that will extract the documentation from my comments and dump it into an HTML file or files.  You know, something like Pydoc or Javadoc.  Does it exist for Racket, something that works in that fashion?  If not, what is available?
> I looked at Scribble, but that looks like one has to make a file separate from the .rkt file and separate the documentation from the implementation between two files.  I'm not fond of that approach (though I may capitulate to adopting it if I have to) because it's hard enough for me to keep the documentation and the implementation in sync when they are in the same file, and I imagine it would be even harder if they are in different files.  Coming from Python, I'm not used splitting the doc and implementation, and I haven't been sold on that way of doing it as yet, but if anyone wants to make any argument why doing it the Scribble way is just as good or better, I'm open to listening.
> Thanks.
> --Christopher
> ____________________
>  Racket Users list:
>  http://lists.racket-lang.org/users

Posted on the users mailing list.