Question on Julia Source and Doc Pages

Looking at the Julia documentation - you can click on “source” and it will take you to a file on github that shows how it is actually written. You can also see that all the documentation/text describing the source is just comment lines split into blocks using """ or ```.

My question is - what tool takes the comments and converts them to the nice documentation pages that we see? Is it some built-in feature of github?

1 Like

It’s Documenter.jl.

1 Like

Here is, by the way, a non-exhaustive list of packages that use Documenter: Examples · Documenter.jl. It takes a bit of time to set-up, but I’m very happy that so many packages use it. Especially the jldoctest part is nice for keeping the docs up-to-date.

1 Like