When using pkgdown::site_build() locally for a package named foo that documents and exports an object named Foo (note the case of the first letter), the link in the Reference tab for that object points to:
https://user.github.io/foo/dev/reference/foo-package.html
instead of the correct local topic page:
file:///me/foo/docs/dev/reference/foo.html
This is what the generated docs/dev/reference/Foo.html file looks like:
<html>
<head>
<meta http-equiv="refresh" content="0;URL=https://user.github.io/foo/dev/reference/foo-package.html" />
<meta name="robots" content="noindex">
<link rel="canonical" href="https://user.github.io/foo/dev/reference/foo-package.html">
</head>
</html>This is a problem that only occurs when running the site locally. Renaming the object to foo (all lower case) fixes the problem.
The issue can be replicated with my package plume that exports an R6 class named Plume. The pkgdown version doesn't seem to matter.
When using
pkgdown::site_build()locally for a package namedfoothat documents and exports an object namedFoo(note the case of the first letter), the link in theReferencetab for that object points to:instead of the correct local topic page:
This is what the generated
docs/dev/reference/Foo.htmlfile looks like:This is a problem that only occurs when running the site locally. Renaming the object to
foo(all lower case) fixes the problem.The issue can be replicated with my package plume that exports an R6 class named
Plume. The pkgdown version doesn't seem to matter.