search

weavejester / codox

Clojure documentation tool
Eclipse Public License 1.0
668 stars 97 forks source link

Suggestion: live documentation #63

Open hlship opened 10 years ago

hlship commented 10 years ago

When working with documentation, I find that my cycle is very slow, as it takes >30 seconds to render the documentation for Rook; I'd love to see that speed up, but I also suspect the real problem is just JVM/Clojure startup and code compilation time.

It would be nice if there was a --watch option that would keep the doc task running, and would identify changes source files and regenerate output files as necessary ... or even expose a live HTTP server to connect to.

weavejester commented 10 years ago

I've just released a new project called lein-auto. I'd be interested to know if this works for you with Codox, or whether it doesn't speed things up enough.

rwilson commented 9 years ago

Another option for addressing the generation speed may be to allow an :only arg, a la lein test :only some.namespace. Admittedly, I haven't profiled whether the doc generation time is the jvm/clojure startup or the doc generation itself. If it's the former, then this really wouldn't help much.