link to packages on github in function documentation

Package development
1

Adding

\link[package]{function}

creates a link in function documentation linking to another package. But this only seems to work for CRAN packages. If there a similar way to link to a package that resides on GitHub?

2

It creates a link to any installed package with the given name.

3

Ah, my bad. I didnt explain properly.
Yes locally that is right.

But when the the function documentation is part of pkgdown documentation hosted on GitHub the link breaks.

sorry for not being clear

4

Maybe the pkgdown autolinking vignette can help?

5

Thanks @maelle,

So i didn't have the pkgdown URL specified in BOTH the DESCRIPTION file and the _pkgdowm.yml.

All seems good now. Thanks a lot

1 Like
6

This topic was automatically closed after 45 days. New replies are no longer allowed.


If you have a query related to it or one of the replies, start a new topic and refer back with a link.