Julia API / Documentation Generation

Question

Does Julia have any built in tools for documentation generation from source? Something like doxygen?

I couldn't find anything natively supported and am curious if something does in fact exist or if someone can recommend an external application.

score 6 · Answer 1 · answered May 08 '14 at 19:10

6

Not yet, but it's a priority to be developed over the summer.

answered May 08 '14 at 19:10

StefanKarpinski

2

Is there a link to the current development efforts regarding this? – Joachim Jul 29 '14 at 19:09
1

As of 0.4, there's built-in Markdown documentation using `@doc`. See here: http://docs.julialang.org/en/release-0.4/manual/documentation/ – Xander Dunn Nov 20 '15 at 18:38
3

You don't need the `@doc` – a string in void context preceding function definition is a doc string in 0.4. – StefanKarpinski Nov 20 '15 at 22:39

score 5 · Accepted Answer · answered May 08 '16 at 22:32

5

There's an update. You can use Documenter.jl to generate documentation from docstrings and markdown files.

answered May 08 '16 at 22:32

krychu

2 Answers2