Skip to content

The robot to automatically generate documentation for Clojure code. Used to generate the API docs for clojure.org.

Notifications You must be signed in to change notification settings

cognitect-labs/autodoc

 
 

Repository files navigation

Autodoc is a program which generates API documentation in HTML from Clojure source code. It can be run as a standalone application or from a build system such as ant or leiningen.

Complete documentation is available at http://tomfaulhaber.github.com/autodoc.

Autodoc is used to generate the documentation for Clojure itself, Clojure-contrib, and Incanter.

I run it on Ubuntu. I expect it would work fine on any Unix, but probably would have some glitches on Windows.

Dependencies: ant, ant-optional, enlive, clojure-contrib

Autodoc is being developed by Tom Faulhaber (to mail me you can use my first name at my domain which is infolace.com).

Autodoc is licensed under the Eclipse Public License 1.0 (like Clojure itself) which can be found in the file epl-v10.html at the root of this distribution. This means it can go anywhere Clojure can go.

Autodoc is hosted at github at https://github.com/tomfaulhaber/autodoc.

About

The robot to automatically generate documentation for Clojure code. Used to generate the API docs for clojure.org.

Resources

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Clojure 63.5%
  • HTML 25.6%
  • CSS 9.3%
  • Shell 1.6%