Daniel, Last night I updated clj-doc so that it should run without problems: if you're willing to try it out I'd be willing to fix any problems that you come up against and let me know about. At this point there are still rough edges that I want to fix and features that I want to add (see the TODO), but going forward it should be runnable at all times. Again, if you find this not to be the case let me know and I'll try jump on it right away.
I haven't updated the docs online - those were only really intended to be an easily accessible demo for the initial alpha release. I've now included a complete set of updated docs in the /example directory of the distribution, so you can use those if you'd like some pre-built docs. I have thoughts for more permanent online reference docs, but those are still in the works. If you'd like to use ant for building docs, you might find Pierre Pracht's build file in his clj-doc fork interesting: http://github.com/ppierre/clj-doc/blob/20005ca48119634cfe089e164d0594120e83d2c8/build.xml Perhaps you could start with that and see if there is a way to make it any simpler. If you found a good way to build docs from ant I may want to include it clj-doc itself for generating the example docs. Thanks for your interest, - Mark On Fri, Jan 30, 2009 at 10:49 PM, Daniel E. Renfer <d...@kronkltd.net> wrote: > > Mark, > > Glad to see you are putting some more work into clj-doc again. I tried > compiling it a couple weeks ago, and after I downloaded the 4 or 5 > libraries it depended on and fixed some of the references to code that > had been moved, I got an exception when I tried running it. I gave up > after that. > > Is clj-doc usable yet, or should I still wait a little bit? Ideally I > would like to be able to include an ant task in my build file that > generates all the documentation for the code in my project much like you > can get in Java-land with javadoc. > > Btw, the bookmark I have to your generated clj-doc documentation is > still my prefered way to find the function I'm looking for. Are you > still keeping that up to date, or has it stagnated since you first > announced it? > > Mark McGranaghan <mmcgr...@gmail.com> writes: >> Hi Kevin, >> >> You should try clj-doc: >> >> http://github.com/mmcgrana/clj-doc >> >> clj-doc generates HTML API documentation that is searchable via >> JavaScript and includes source snippets for the code that defined each >> var. >> >> I update clj-doc tonight to include example docs, just clone my >> clj-doc repo and open example/index.html in your browser to see what >> the docs look like. >> >> In my update I also made it easier to generate docs for your own sets >> of libs: check out the README and let me know if you have any >> questions/problems. >> >> I've had clj-doc on hold for a little while as I've been waiting for >> various documentation-related features to find their way into core, >> especially the ns docstrings. Now that we have most of those (though >> (def foo "docstring" :bar) is noticeably missing) I'm going to be >> working more on clj-doc. >> >> Hope you find it useful, >> - Mark McGranaghan >> > > > > --~--~---------~--~----~------------~-------~--~----~ 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 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 -~----------~----~----~----~------~----~------~--~---
