Mark- ATM, autodoc is your best bet for automatically generating documentation from your source files.
The ClojureDocs lib analyzer codebase is pretty much a ns / var metadata extraction tool, similar to autodoc. Unfortunately out of the five requirements you listed [1] we only (automatically) take care of two: doc strings and namespace dependencies. Examples aren't parsed out of the source code, they're added by the community after the fact. That said, the analyzer will be open-sourced in the near future. It sounds like you're in a unique minority for (1) having a large Clojure project, and (2) gone through the process of fully documenting it, so I'd love to hear an update on which way you decide to go with this. -Zack [1] Doc strings, usage notes, examples, namespace dependencies, and organization by topic or importance. On Sep 6, 3:48 pm, Mark Engelberg <mark.engelb...@gmail.com> wrote: > On Mon, Sep 6, 2010 at 2:51 AM, Tim Daly <d...@axiom-developer.org> wrote: > > The literate programming discussion centered around the question > > "what should be the state of the art in clojure documentation", > > not "what is the state of the art in clojure documentation". > > I brought up literate programming as an example of a recent thread in > which people talked about pushing the envelope of Clojure doc tools. > I like literate programming and continue to be curious about any new > Clojure tools that support literate programming or are inspired by it > in some way. But that was not really the main point of my post. > > At this moment, I'm primarily interested in finding something that > makes it easy to automatically extract and present API information > (doc strings, usage notes, examples, namespace dependencies), in a way > that is organized by topic or importance. Is autodoc the best > available tool? Is there something else that works on Windows? Are > there other doc tools that people are happy with? For example, what > does the new ClojureDocs website use? Is that technology available > for general use? -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en
