Flux.jl
Flux.jl copied to clipboard
use DocumenterVitepress.jl for documentation
It would we nice to have a right pane in doc pages https://fluxml.ai/Flux.jl/dev/reference/models/layers/ so that one can see all layers at a glance and quickly jump to any one of them
With DocumenterVitepress.jl we would have a nice right pane https://luxdl.github.io/DocumenterVitepress.jl
Discussion of right pane for Documenter.jl is in https://github.com/JuliaDocs/Documenter.jl/issues/1688
Alternatives are
- the creation of an
@indexhttps://documenter.juliadocs.org/stable/man/syntax/#@index-block - making the docstring collapsed by default setting
CollapsedDocStrings = truehttps://documenter.juliadocs.org/dev/man/syntax/#@meta-block
One vote against.
If the page listing layers is really too hard to navigate, it can be split up, or given a table of contents. But I'm not convinced it is.