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

Updates to work with {pkgdown} >= 2.1.0 #153

Merged
merged 9 commits into from
Jul 18, 2024
Merged

Updates to work with {pkgdown} >= 2.1.0 #153

merged 9 commits into from
Jul 18, 2024

Conversation

joshwlambert
Copy link
Member

This PR makes several updates to ensure maximum compatibility with the newest {pkgdown} release (2.1.0).

  • All vignettes now use output: rmarkdown::html_vignette (some vignette were previously using bookdown::html_vignette2), as this reduces complications with {pkgdown} rendering (https://pkgdown.r-lib.org/reference/build_articles.html#output-formats).
  • Remove pkgdown: as_is: true from vignettes to ensure math mode renders correctly
  • Change development: mode: auto to mode: unreleased to ensure online documentation is always up-to-date with GitHub package (this will be reverted when {simulist} is hosted on CRAN)
  • code_folding: show has been removed from all vignettes as it is not supported by {pkgdown} without as_is: true. class.source = 'fold-hide' is also removed from code chunks as a result. The alternative to use <details> (as recommended in {pkgdown} support code folding r-lib/pkgdown#1433) is not equivalent as it also folds the output of the code chunks including plots, therefore it was decided not use it. By default all code is shown including plotting code, which was folded by default in previous versions.
  • The bullet point discussing the use of rmarkdown::html_vignette and bookdown::html_vignette2 and its influence on interactive plots (html widgets) has been removed as it is no longer necessary as all vignettes use rmarkdown::html_vignette.
  • Manual figure numbering has been removed from vis-linelist.Rmd vignette. All other vignettes no longer have figure numbering due to removing bookdown::html_vignette2 and as_is: true.

@joshwlambert joshwlambert added documentation Improvements or additions to documentation pkg infrastructure General update tasks relating to the package and not functionality labels Jul 18, 2024
Copy link

This pull request:

  • Adds 0 new dependencies (direct and indirect)
  • Adds 0 new system dependencies
  • Removes 1 existing dependencies (direct and indirect)
  • Removes 1 existing system dependencies

(Note that results may be inaccurate if you branched from an outdated version of the target branch.)

@joshwlambert joshwlambert merged commit bdf69fb into main Jul 18, 2024
9 checks passed
@joshwlambert joshwlambert deleted the pkgdown-updt branch July 18, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pkg infrastructure General update tasks relating to the package and not functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants