Tom Faulhaber <tomfaulha...@gmail.com> writes:

> Now your project can have the same documentation as Clojure, clojure-
> contrib, and Incanter!
>
> The standalone autodoc tool is now available. It can be run from the
> command line and it integrates with Leiningen and ant. (Maven still to
> come - let me know if you want to help.)
>
> Autodoc builds full, styled HTML documentation from your doc-strings
> and other metadata you supply. It includes a project overview page,
> separate pages for each namespace, and an overall index page.
>
> It builds pages suitable for use with github pages so you can easily
> publish documentation and can include links to source code if you
> publish source.
>
> Documentation on how to get and use Autodoc is here:
> http://tomfaulhaber.github.com/autodoc/ (apologies for the fact that
> the doc is not yet pretty!).
>
> I hope that Autodoc helps you increase the quality of documentation
> for your projects.

Looks great! A couple comments.

* Adding "by unknown author" to namespaces that have no author metadata
  seems a bit superfluous.

* Have you thought about a task to automatically upload the HTML files
  to github? I haven't used Github Pages; is this something that could
  be done using jcsh, or would it require shelling out to scp?

* It would be great to be able to provide a logo image that would be
  included as in Incanter's docs.

Thanks for getting this all packaged up.

-Phil
-- 
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

Reply via email to