Updates to work with {pkgdown} >= 2.1.0 #153
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes several updates to ensure maximum compatibility with the newest {pkgdown} release (2.1.0).
output: rmarkdown::html_vignette
(some vignette were previously usingbookdown::html_vignette2
), as this reduces complications with {pkgdown} rendering (https://pkgdown.r-lib.org/reference/build_articles.html#output-formats).pkgdown: as_is: true
from vignettes to ensure math mode renders correctlydevelopment: mode: auto
tomode: 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} withoutas_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.rmarkdown::html_vignette
andbookdown::html_vignette2
and its influence on interactive plots (html widgets) has been removed as it is no longer necessary as all vignettes usermarkdown::html_vignette
.vis-linelist.Rmd
vignette. All other vignettes no longer have figure numbering due to removingbookdown::html_vignette2
andas_is: true
.