It's still a bit in flux as the old style is:

@doc """
my docs...
""" ->
myfun(x) = ...

The new style is:

"""
my docs...
"""
myfun(x) = ...

The new style is in Docile but not in v"0.4-", yet.

The documentation inside Docile is a good start. It uses the new style.
Some other notable packages include:

* https://github.com/johnmyleswhite/CSVReaders.jl

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

In Sims.jl, I used Mkdocs (mkdocs.org) along with Docile/Lexicon to create
that documentation site.






On Tue, Jan 13, 2015 at 4:59 PM, Douglas Bates <[email protected]> wrote:

> I'm having difficulty navigating my way around documentation standards for
> v"0.4-", and whether the Docile or Lexicon or Markdown packages are
> needed.  What would be a good package to study to see how @doc, etc. should
> be used?
>

Reply via email to