This guide notes some commonly-used tools for generating project documentation.
What Version of Clojure Does This Guide Cover?
This guide covers Clojure 1.4.
Projects commonly (hopefully?) have at least two types of documentation:
- standalone markdown-formatted docs in the project's doc directory
There are a number of tools for generating handsome API docs from docstrings and other project metadata.
If you'd like to generate nice-looking html API docs for your library,
use codox. Usage instructions
are in the codox readme. Running codox (it's a lein plug-in and is run
lein doc in your project) will create a "doc" subdirectory
containing the resulting html.
If you'd like to render API docs side-by-side with the source code it's documenting, use the marginalia lein plug-in. Usage instructions are in the readme.
If you'd like to generate copious raw data from a project (which includes docstrings as well as other metadata), have a look at cadastre.