ibdknox/noir — Issue #66: Documentation options
Author: Raynes
Created: 2011-12-26 18:30:27+00:00
State: open

Howdy. I figured that since we're still having some trouble deciding what to do about generating docs in the future, we should have an issue about it for discussion. That and I don't have any way of getting hold of you when you're not on IRC. :p

So, good ol' @weavejester has written his very own [documentation generation tool](https://github.com/weavejester/codox) out of frustration with autodoc (the same we've had). It is still in the early stages, but he is using it for Ring and Compojure. I generated [some noir docs](http://www.raynes.me/hfiles/noirdocsexample/) with it earlier and they look pretty good.

It doesn't have much in the way of options for customizing output and such yet, but I think that it is a better base that we can build on, and @weavejester is very, very receptive to patches/suggestions. He actually fixed a bug that I found when generating the noir docs and released a new version in about 10 minutes earlier.

So, codox is one option. Marginalia is another, but without some modifications, it isn't a very good option for general reference/API docs.

Thoughts?