Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] fix broken links in pkgdown #212

Merged
merged 1 commit into from
May 12, 2020

Conversation

jameslamb
Copy link
Collaborator

Inspired by microsoft/LightGBM#3036.

I never noticed it, but the Source: links on our pkgdown site are broken right now. For example, go to https://uptake.github.io/uptasticsearch/reference/es_search.html and click the link R/es_search.Rafter Source:.

image

pkgdown creates these links automatically if you have a GitHub link in URL or BugReports in DESCRIPTION. 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 running make 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:

repo:
  url:
    home: https://github.com/uptake/uptasticsearch/
    source: https://github.com/uptake/uptasticsearch/tree/master/r-pkg/
    issue: https://github.com/uptake/uptasticsearch/issues
    user: https://github.com/

@codecov-io
Copy link

Codecov Report

Merging #212 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #212   +/-   ##
=======================================
  Coverage   93.13%   93.13%           
=======================================
  Files           8        8           
  Lines         597      597           
=======================================
  Hits          556      556           
  Misses         41       41           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6b90f6c...7e1e9ac. Read the comment docs.

Copy link
Collaborator

@austin3dickey austin3dickey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, whoops!

@jameslamb jameslamb merged commit 6376042 into uptake:master May 12, 2020
@jameslamb jameslamb deleted the docs/fix-source-links branch June 1, 2021 04:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants