Documentation

[simonster]

We need better documentation for the functions here than a list in the README. We should probably pick some other package whose docs we like and use the same approach they do. It looks like most packages have one page per category of functions (e.g. Distributions) although some have one page per function (e.g. Winston). The Julia docs have one page for all functions in the standard library, although that approach seems less than optimal for functions that do more complicated things.

[jfsantos]

I like the way it is done in Distributions. I am going to push a documentation skeleton in a few minutes so we can work from there.

EDIT: done in pull request #6.

[jfsantos]

Documentation for master is going to appear at http://dspjl.readthedocs.org/en/latest/ automatically from now on.

[jfsantos]

To be able to access documentation from the REPL, I think we'll have to do something similar to what is done in JuliaLang/julia. I think we have to add the JuliaDoc extensions to our docs to be able to do that.

[simonster]

My understanding is that packages still can't hook into help in a sane way. See JuliaLang/julia#3988 for some recent discussion.

[jfsantos]

You are right. Let's wait until this is solved so we'll know what to do. Meanwhile, our docs will have to do the trick.