Bug: Linking across packages doesn't work

[bundfussr]

What happened?

It seems that the cross-linking across admiral packages doesn't work. The links to admiral functions in the documentation of the admiral extension packages are invalid, e.g., https://pharmaverse.github.io/pharmaverse.github.io/admiral/v1.4.0/cran-release/reference/derive_vars_merged.html

Session Information

No response

Reproducible Example

No response

[bms63]

Did it work before we released 1.4.0?

[bundfussr]

Did it work before we released 1.4.0?

It didn't work for 1.3.0 and it worked in the past. I don't know when it stopped. As far as I remember we had docs/pkgdown.yml added for cross-linking. It was removed some time ago but I don't remember why.

[bms63]

umm...vaguely remembering...did we add it when we were not using the multi-version?? maybe it got dropped when Dinakar re-installed multi-version job

[bundfussr]

We had it in 0.11 but not in 0.12. Thus it seems that we removed it when we stopped using multi-version.

[bms63]

does it work with the teal packages? maybe insighteng could help us here?

[m7pr]

@bundfussr @bms63 those should be links that work

https://pharmaverse.github.io/admiral/cran-release/reference/derive_var_extreme_flag.html
https://pharmaverse.github.io/admiral/v1.4.0/reference/derive_vars_merged.html
https://pharmaverse.github.io/admiral/v1.3.0/reference/derive_vars_merged.html
https://pharmaverse.github.io/admiral/v1.2.0/reference/derive_vars_merged.html
https://pharmaverse.github.io/admiral/v1.1.0/reference/derive_vars_merged.html

So the cross-linking between versions works, you just posted an invalid link in your first comment in this thread

[bundfussr]

@bundfussr @bms63 those should be links that work

https://pharmaverse.github.io/admiral/cran-release/reference/derive_var_extreme_flag.html https://pharmaverse.github.io/admiral/v1.4.0/reference/derive_vars_merged.html https://pharmaverse.github.io/admiral/v1.3.0/reference/derive_vars_merged.html https://pharmaverse.github.io/admiral/v1.2.0/reference/derive_vars_merged.html https://pharmaverse.github.io/admiral/v1.1.0/reference/derive_vars_merged.html

So the cross-linking between versions works, you just posted an invalid link in your first comment in this thread

Sorry, I think I should have provided more details. The targets like shown above are all available in the gh-pages branch of admiral and also on https://pharmaverse.github.io/admiral.

The problem is that if you generate the documentation of an extension package, e.g., admiralonco, the links to admiral functions are not correct. Consider for example https://pharmaverse.github.io/admiralonco/v1.3.0/articles/adrs.html. In the introduction of this page the admiral function derive_extreme_event() is mentioned and linked but the link is invalid: https://pharmaverse.github.io/pharmaverse.github.io/admiral/v1.3.1/cran-release/reference/derive_extreme_event.html