search

r-lib / pkgdown

Generate static html documentation for an R package
https://pkgdown.r-lib.org/
Other
717 stars 335 forks source link

Skip selected vignettes #457

Closed maxheld83 closed 6 years ago

maxheld83 commented 6 years ago

I was looking for a way to skip building some (yet incomplete, therefore failing) vignettes.

I can skip it for R CMD check with .rbuildignore, but this doesn't affect pkgdown::build_site() (as intended).

I was hoping that manually listing only a subset of *.Rmds inside my _pkgdown.yml would make pkgdown skip the remainder, but nope.

So I ended up putting the drafts in a hidden vignettes/.drafts/ subdirectory, which is quite ugly.

hadley commented 6 years ago

One easy fix would be to just add knitr::opts_chunk$set(eval = FALSE) to the start of the document.

Adding something to _pkgdown.yml is either going to be quite a lot of work or quite hacky, so I'd prefer not to implement right now.

pokyah commented 5 years ago

maxDiscovering pkgdown and was encountering the same problem as @maxheld83

What would you think about adding a key in the header specifying that the vignette is still in draft mode ?

title: "Future Vignette" author: "pokyah" date: "11/27/2018" output: html_document draft: TRUE

Would it make sense to implement this proposition ?