Attention #JuliaLang package devs! Use DocumenterInterLinks.jl! If you haven't built your docs in forever, rebuild them with a recent Documenter version so they include an inventory file so others can interlink with them. That is all. github.com/JuliaDocs/Do... - ThreadSky

sethaxen.com • 88 days ago

Attention #JuliaLang package devs! Use DocumenterInterLinks.jl! If you haven't built your docs in forever, rebuild them with a recent Documenter version so they include an inventory file so others can interlink with them. That is all. https://github.com/JuliaDocs/DocumenterInterLinks.jl

Comments

ronnybergmann.net•88 days ago

Yes! Together with DocumenterCitations.jl my favourite extension of Documenter.jl https://juliadocs.org/DocumenterCitations.jl/stable/

Use them, cross ref to other docs and cite your sources.

ronnybergmann.net•88 days ago

and for both packages of course a huge thanks to @michaelgoerz.net !

sethaxen.com•87 days ago

Nice! Been planning to test out DocumenterCitations.jl. I see the docs now directly address my main concern (REPL formatting): https://juliadocs.org/DocumenterCitations.jl/stable/syntax/#Citations-in-docstrings

ronnybergmann.net•87 days ago

Is REPL rendering fixed? I only see the issue still active, but you are right, https://github.com/JuliaDocs/DocumenterCitations.jl/issues/21 seems to be resolved now. Super nice!

sethaxen.com•87 days ago

Ah, I didn't think of that issue. That Julia base pre-processes markdown in docstrings for rendering the REPL also would affect DocumenterInterLinks. e.g. an `@extref` will appear next to an entry in the REPL, though it gets rendered as a link in the docs.

ronnybergmann.net•87 days ago

That is indeed fixed in 1.11 :) both extref and cite are rendered nicely on REPL

sethaxen.com•87 days ago

Strange, I just checked on v1.11 and saw the lagging extref.