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

Bump version of pkgdown #3036

Closed
StrikerRUS opened this issue Apr 29, 2020 · 4 comments
Closed

Bump version of pkgdown #3036

StrikerRUS opened this issue Apr 29, 2020 · 4 comments

Comments

@StrikerRUS
Copy link
Collaborator

Summary

Build R documents with new version of pkgdown.

Motivation

1.5 version introduces repo$url config option. This option will allow to drop our ugly postprocessing JS workaround for incorrect source files links as our R package is located in a subdirectory:
https://github.com/microsoft/LightGBM/blob/master/R-package/pkgdown/extra.js

References

r-pkgdown=1.3.0=r35h6115d3f_1001 \

You can now control the links to source files (in reference pages and
articles) and issues and users (in the NEWS) with new repo$url config
option (r-lib/pkgdown#1238). This makes it easier to use pkgdown with GitHub enterprise, packages in subdirectories, and other source hosts (like bitbucket).

https://github.com/r-lib/pkgdown/releases/tag/v1.5.0

@StrikerRUS
Copy link
Collaborator Author

Closed in favor of being in #2302. We decided to keep all feature requests in one place.

Welcome to contribute this feature! Please re-open this issue (or post a comment if you are not a topic starter) if you are actively working on implementing this feature.

@jameslamb
Copy link
Collaborator

re-opening this since I think it will be fixed by open PR #3072

Leaving some notes for myself. You can see the details of the relevant pkgdown changes in R/build.r section of https://github.com/r-lib/pkgdown/pull/1253/files, namely:

#' @section YAML config - repo:
#' pkgdown automatically generates links to the source repository in a few
#' places
#'
#' * Articles and documentation topics are linked back to the
#'   underlying source file.
#'
#' * The NEWS automatically links issue numbers and user names.
#'
#' * The homepage provides a link to  "Browse source code"
#'
#' pkgdown automatically figures out the necessary URLs if you link to a GitHub
#' or GitLab repo in your `BugReports` or `URL` field. Otherwise, you can
#' supply your own in the `repo` component:
#'
#' ```yaml
#' repo:
#'   url:
#'     home: https://github.com/r-lib/pkgdown/
#'     source: https://github.com/r-lib/pkgdown/blob/master/
#'     issue: https://github.com/r-lib/pkgdown/issues/
#'     user: https://github.com/
#' ```
#'
#' * `home`: path to package home on source code repository.
#' * `source:`: path to source of individual file in master branch.
#' * `issue`: path to individual issue.
#' * `user`: path to user.
#'
#' The varying components (e.g. path, issue number, user name) are pasted on
#' the end of these URLs so they should have trailing `/`s.

So to check that a fix to this worked, after removing R-package/pkgdown/extra.js, check that:

image

odimka pushed a commit to odimka/LightGBM that referenced this issue May 17, 2020
…icrosoft#3036) (microsoft#3072)

* [R-package] [docs] remove devtools dependency for docs builds

* linting

* updating docs conda env

* empty roxygenize()

* env for R libraries

* get logs

* remove comment

* added pkgdown URLs

* more paths

* fix incorrect YAML keys

* update DESCRIPTION URL link

* more URL changes

* revert DESCRIPTION changes

* remove ca-certificates

* empty commit

* Update docs/conf.py

Co-authored-by: Nikita Titov <nekit94-08@mail.ru>

* empty commit

* remove outdated line in build_r.R

Co-authored-by: Nikita Titov <nekit94-08@mail.ru>
@StrikerRUS StrikerRUS reopened this May 18, 2020
@StrikerRUS
Copy link
Collaborator Author

Sorry, missclick.

ChipKerchner pushed a commit to ChipKerchner/LightGBM that referenced this issue Jun 10, 2020
…icrosoft#3036) (microsoft#3072)

* [R-package] [docs] remove devtools dependency for docs builds

* linting

* updating docs conda env

* empty roxygenize()

* env for R libraries

* get logs

* remove comment

* added pkgdown URLs

* more paths

* fix incorrect YAML keys

* update DESCRIPTION URL link

* more URL changes

* revert DESCRIPTION changes

* remove ca-certificates

* empty commit

* Update docs/conf.py

Co-authored-by: Nikita Titov <nekit94-08@mail.ru>

* empty commit

* remove outdated line in build_r.R

Co-authored-by: Nikita Titov <nekit94-08@mail.ru>
ChipKerchner pushed a commit to ChipKerchner/LightGBM that referenced this issue Jun 11, 2020
…icrosoft#3036) (microsoft#3072)

* [R-package] [docs] remove devtools dependency for docs builds

* linting

* updating docs conda env

* empty roxygenize()

* env for R libraries

* get logs

* remove comment

* added pkgdown URLs

* more paths

* fix incorrect YAML keys

* update DESCRIPTION URL link

* more URL changes

* revert DESCRIPTION changes

* remove ca-certificates

* empty commit

* Update docs/conf.py

Co-authored-by: Nikita Titov <nekit94-08@mail.ru>

* empty commit

* remove outdated line in build_r.R

Co-authored-by: Nikita Titov <nekit94-08@mail.ru>
@github-actions
Copy link

This issue has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants