search

fredrikekre / Literate.jl

Simple package for literate programming in Julia
https://fredrikekre.github.io/Literate.jl
Other
534 stars 61 forks source link

Remove @extref from non-Documenter output #245

Closed musoke closed 4 months ago

musoke commented 4 months ago

I am unsure whether this is a bug fix or a new feature.

Recent versions of Documenter use @extref links to refer to the documentation of external packages. This was introduced in https://github.com/JuliaDocs/Documenter.jl/issues/2366 and https://github.com/JuliaDocs/Documenter.jl/pull/2424 and currently is documented at https://documenter.juliadocs.org/stable/man/syntax/#@extref-link.

This pull request removes @extref links in the same way and under the same conditions as @ref and @id tags.

This is technically a breaking change if it is not considered a bug fix. It seems natural though, especially if the @extref syntax becomes more widely adopted.

I attempted to write a changelog entry but it is quite likely that I got the syntax wrong.

fredrikekre commented 4 months ago

Thanks a lot! Really appreciate that it comes with test and changelog.

musoke commented 4 months ago

Oh, that was faster than expected!

Thank you for the package!

fredrikekre commented 4 months ago

Release: https://github.com/JuliaRegistries/General/pull/105051

musoke commented 4 months ago

You merged and released this before I managed to get my CI building docs with my patch. Simplifies my life :smiley_cat: