Question

autodoc + gh-pages for cljs.*.api namespaces

Answer 1

Comment made by: venantius

I just tried to get this working - unfortunately, autodoc doesn't currently have support for ClojureScript. An issue is currently open on the GH project (link: https://github.com/tomfaulhaber/autodoc/issues/16 text: here) but it doesn't look like it's seen any movement in nearly two years.

Answer 2

Comment made by: tomfaulhaber

I would love to see this work as well and, as the author of autodoc, am happy to help move it forward. I've added some commentary to the (link: https://github.com/tomfaulhaber/autodoc/issues/16 text: issue in autodoc) about how to do this. If it's going to happen soon, though, I will need some help from the ClojureScript community as outlined over there.

Answer 3

Comment made by: dnolen

This ticket is about generating docs for Clojure code. Getting autodoc to work for ClojureScript files is worth pursuing but unrelated to this ticket.

Answer 4

Comment made by: bensu

I took at stab at (link: http://bensu.github.io/clojurescript-docs/ text: this) and only got it running using {{autodoc-0.9.0-standalone.jar}} from the command line. My results are not useful at all but those issues should be sorted out in autodoc.

David, do you have a preference in how the docs and artifacts needed should be managed? Should it be a lein plugin or can it be a script that assumes that the correct jars have been installed?

Answer 5

Comment made by: tomfaulhaber

Oh, I did misunderstand this and then didn't see (link: ~dnolen)'s follow-up until now. Let me take a look at whether I can make this happen pretty easily. I wouldn't think it would be too difficult. (Famous last words!)

Answer 6

Comment made by: tomfaulhaber

I have just closed the blocking issue in autodoc (link: https://github.com/tomfaulhaber/autodoc/issues/21 text: Issue 21), and(link: ~bensu) has successfully built a version of doc for the src/main/clojure/... stuff.

The next step is to flesh out what we want to push to http://clojure.github.io/clojurescript. I don't think that this is too hard. Then we can integrate it with the autodoc robot and get automatic updates.

Answer 7

Reference: https://clojure.atlassian.net/browse/CLJS-1446 (reported by dnolen)