pkgdown docs

[robkooper]

I don't think we are still generating these? If this is generated do we want to do this as part of the build process? Do we want to delete all the docs in base/*/docs?

[mdietze]

FWIW, I think we should fix the build on these. Could we link their build to the Travis build GitHub Actions? like we do with the rest of the documentation?

[dlebauer]

Implementation ideas

1. create build_pkgdown.R:

args <- commandArgs(trailingOnly = TRUE)
if (length(args) == 0) {
  stop("No package names provided. Please pass package names as arguments.")
}
packages <- args
PEcAn.logger::logger.info("Building pkgdown docs for: ", paste(packages, collapse = ", "))

for (pkg in packages) {
  message("Building pkgdown site for: ", pkg)
  pkgdown::build_site(pkg)
  
  # Copy built site folder for the book.
  dest <- file.path("book_source/pkgdocs", pkg)
  if (!dir.exists(dest)) { # this prob. only needs to be done once per pkg
    dir.create(dest, recursive = TRUE, warn = FALSE)
  }
  
  source_docs <- file.path(pkg, "docs")
  
  file.copy(from = source_docs, to = dest, recursive = TRUE, overwrite = TRUE)
}

2. Update Makefile

• There is a list of packages in the first 11 lines of GitHub.com/pecanproject/pecan Makefile, these are concatenated into the variable ALL_PKGS. Can also get packages with PEcAn.all::pecan_version()
• Add:

pkgdocs:
    Rscript build_pkgdown.R $(ALL_PKGS)

• add pkgdocs to .PHONY

3. Add to build

• update book_source/Makefile and / or .github/workflows/book.yml (or create new workflow?)

See also

• pkgdown docs: https://pkgdown.r-lib.org

PecanProject/pecan#3098 (comment)

the package documentation pages are out of date because they are not updated by the Github Actions build process the way the long-form PEcAn book is.

Anyone who wants to work on this could start by understanding how book.yml works and then work on modifying it to include compilation of the package docs.

@ashiklom it looks like you were one of the last to work on the pkgdown docs, back when we were using Travis. Any advice appreciated!

[divine7022]

Issue fixed in PecanProject/pecan#3454

[allgandalf]

I think we are now working on this issue as part of :

• Deploy Pkgdown Documentation to Separate Repository pecan#3482

[allgandalf]

@dlebauer should we transfer this issue to pecan repository ? , we can do it following this button