[docs] fix broken links in pkgdown #212
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Inspired by microsoft/LightGBM#3036.
I never noticed it, but the
Source:
links on ourpkgdown
site are broken right now. For example, go to https://uptake.github.io/uptasticsearch/reference/es_search.html and click the linkR/es_search.R
afterSource:
.pkgdown
creates these links automatically if you have a GitHub link inURL
orBugReports
inDESCRIPTION
. It then assumes that the R package is at the repo root (like most only-an-R-package repos). So this has probably been broken since we added Python...only a couple years 😬The changes in this PR were produced by upgrading to
pkgdown
1.5.1 and runningmake gh_pages
from the root of the repo. Most of the changes are miscellaneous "pkgdown
was updated" things, but the main change to fix the links is in_pkgdown.yml
: