Docile.jl works great. With Lexicon (or base Julia 0.4dev), you get nice
REPL help.

Mkdocs (http://mkdocs.org) works great for taking Markdown from Docile
output along with other Markdown files to make online documentation. Mkdocs
is super easy and works great with Github Pages. It also works with
readthedocs (but I haven't tried that).

Here is an example of package documentation developed with Docile and
Mkdocs (still a work in progress):

https://tshort.github.io/Sims.jl/



On Fri, Jan 9, 2015 at 3:41 AM, Ján Dolinský <jan.dolin...@2bridgz.com>
wrote:

> Hi,
>
> I would like to know how to write a help (comment) text e.g. for a module
> function so that once module is loaded it is displayed if in REPL help mode.
> E.g. for "sum" function
> help?>sum
> displays brief help text for "sum"
>
> Thanks,
> Jan
>

Reply via email to