search

matrixfunctions / GraphMatFun.jl

Computation graphs for matrix functions
MIT License
13 stars 0 forks source link

References not appearing in documentation #55

Closed jarlebring closed 3 years ago

jarlebring commented 3 years ago

The docscring references do not appear in the docs page, eg https://matrixfunctions.github.io/GraphMatFun.jl/dev/generators/ graph_ps etc.

eringh commented 3 years ago

We seem to have converted to using footnotes.

A Google search away I found quite some discussions and wishes for a nice citation system. A problem with the footnotes is that they are repeated at the bottom of the generated page, so that there is no re-use. There is a related issue (566) at https://github.com/JuliaDocs/Documenter.jl/issues

mfasi commented 3 years ago

A problem with the footnotes is that they are repeated at the bottom of the generated page, so that there is no re-use.

Thanks for spotting this, it's quite unfortunate. The easiest thing to do would be to revert the format for the references, I think. If you have better solutions please let me know, otherwise I'll take up this one (I caused the issue in the first place, after all).

jarlebring commented 3 years ago

Yes. It seems the advanced way of doing references doesnt display very nicely. I agree to reverting.