Open rbcavanaugh opened 4 months ago
The link is behind an "html"
flag in the Rd file:
The first step would be to check if this link appears in the markdown file produced by .rd2qmd()
I see, the link correctly appears in the qmd file but it links to the badge that is located in man/figures
and this badge is not imported in the docs
folder.
Can we swap the lifecycle
line with some kind of conditional link? It feels silly to import another package and build complicated backend code just to insert an image and a link in the docs...
IIUC we wouldn't have to import lifecycle
, we would just need to copy all the SVG badges from man/figures
(I guess those are created by devtools::document()
) to docs/man/figures
. We don't have to use any functionalities from lifecycle
itself
I was thinking there must exist a one-liner to load an image from a website without altdoc having to do anything at all.
But I've not tried to find one yet...
If that one-line doesn't exist or is too complicated, we should support a more general interface to inserting images in documentation.
I just think we should resist the temptation to replicate every possible tidyverse
functionality with dedicated arguments and backend code, and try to think of more general ways to do things.
If I have the following in my function roxygen2 documentation
I get the following on the generated reference page for the function:
(link to function: https://github.com/roux-ohdsi/allofus/blob/main/R/aou_temp_tables.R and site: https://roux-ohdsi.github.io/allofus/man/aou_create_temp_table.html)