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

Consider moving the pkgdown process and docs to separate workflows, and update deployment #798

Open
johnkerl opened this issue Jan 8, 2025 · 1 comment
Assignees

Comments

@johnkerl
Copy link
Collaborator

johnkerl commented Jan 8, 2025

Follow-up from #797 (comment)

@jdblischak
Copy link
Collaborator

Some notes:

  • Current manual process to update documentation is in wiki page Building the Package Documentation
  • The example GitHub Actions workflow for pkgdown deployment from r-lib/actions demonstrates the step for pushing to the gh-pages branch. We should be able to simply copy-paste the last two steps (plus a step to install pkgdown). The earlier setup steps using r-ci.sh can be copied from ci.yaml
  • For the vignettes, the source files are the .md files, which then generate the .Rmd files via vignettes/Makefile. If we want to keep this system, the new docs workflow should run cd vignettes && make. If we prefer to use Rmd as the source, then we should delete the .md files and Makefile to reduce the amount of duplication in the repo
  • To have both a release and development version of the docs, we can specify mode: auto for the Development mode
development:
  mode: auto

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants