Julia: Add table of contents on top of API doc pages

Created on 8 May 2020  Â·  3Comments  Â·  Source: JuliaLang/julia

Is it possible to add the content and URL at the beginning of some module as Qt document? This will save the beginning users a lot of time to find some functions. The figures of the comparison between Qt and Julia documents can be found at
https://discourse.julialang.org/t/more-convenient-julia-document/39062

Most helpful comment

Cool! Maybe we should do that for manual chapters?

All 3 comments

Would be more of a Documenter feature, I believe, rather than something to be implemented here.

cc @mortenpi, @fredrikekre — thoughts?

It is already supported if you add a @contents-block. Looks like this https://juliadocs.github.io/Documenter.jl/stable/lib/public/#Index-1

Cool! Maybe we should do that for manual chapters?

Was this page helpful?
0 / 5 - 0 ratings