Figure out a better way to do documentation

[reality]

There has to be a way we can auto-generate documentation to a degree. This would be nice because our README.md files are repeating a lot of data and it's getting frustrating. Is there some kind of Javascript library that can scan the source code and generate documentation from docstrings and such? If not, I'll write one.

[reality]

http://jashkenas.github.io/docco/ This might provide a good basis

[SamStudio8]

Docco looks good. On May 17, 2013 7:49 PM, "Luke Slater" [email protected] wrote:

http://jashkenas.github.io/docco/ This might provide a good basis

— Reply to this email directly or view it on GitHubhttps://github.com/reality/depressionbot/issues/452#issuecomment-18079451 .

[SamStudio8]

It would also be a trivial exercise to have a commit hook to update the README files automagically. On May 17, 2013 7:49 PM, "Luke Slater" [email protected] wrote:

http://jashkenas.github.io/docco/ This might provide a good basis

— Reply to this email directly or view it on GitHubhttps://github.com/reality/depressionbot/issues/452#issuecomment-18079451 .

[reality]

Docco isn't really useful.

There's this: http://usejsdoc.org/about-getting-started.html which I'm not stoked about using everywhere but it would be useful for generating documentation for the API at least.