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

Use Travis-ci vignette build for web-linked vignettes instead of CRAN #219

Closed
eliotmcintire opened this issue Aug 18, 2015 · 5 comments
Closed
Assignees

Comments

@eliotmcintire
Copy link
Contributor

@eliotmcintire eliotmcintire commented Aug 18, 2015

See instructions here: https://rmflight.github.io/posts/2014/11/travis_ci_gh_pages.html

This allows quicker update cycle for vignettes to follow development branch. Also, the CRAN vignettes don't look very good.

@eliotmcintire eliotmcintire changed the title Use Travis-ci vignette build instead of CRAN Use Travis-ci vignette build for web-linked vignettes instead of CRAN Aug 18, 2015
@achubaty
Copy link
Contributor

@achubaty achubaty commented Aug 18, 2015

Thanks for looking into this -- I agree that building them ourselves is the way to go.

@achubaty achubaty self-assigned this Aug 18, 2015
@achubaty
Copy link
Contributor

@achubaty achubaty commented Aug 28, 2015

added vignettes to gh-pages branch (488840e) and updated links on wiki.

working on getting the script to auto-build and push these.

achubaty added a commit that referenced this issue Aug 28, 2015
* build vignettes then push to gh-pages branch
@achubaty
Copy link
Contributor

@achubaty achubaty commented Aug 28, 2015

sigh i have a feeling we can't test this correctly because the builds fail due to the rgdal problem (see #192) 👎

achubaty added a commit that referenced this issue Aug 28, 2015
achubaty added a commit that referenced this issue Aug 28, 2015
achubaty added a commit that referenced this issue Aug 28, 2015
achubaty added a commit that referenced this issue Aug 28, 2015
achubaty added a commit that referenced this issue Aug 28, 2015
achubaty added a commit that referenced this issue Aug 28, 2015
achubaty added a commit that referenced this issue Aug 28, 2015
@achubaty
Copy link
Contributor

@achubaty achubaty commented Aug 29, 2015

OK, so the GitHub part is mostly sorted out (it's a bit convoluted and I think I can improve it).

The main issue remaining is that the way R CMD build creates the vignettes is completely different from how RStudio's Ctrl+Shift+K does it. The reason the vignettes look terrible on CRAN and in the package is because they lack RStudio's magic, which includes:

  1. adding authors
  2. adding table of contents
  3. dealing with refs and citations

Not sure yet what Rstudio is actually running when it builds the vignettes. I know it's not just using knitr::knit nor devtools::build_vignettes.

@achubaty
Copy link
Contributor

@achubaty achubaty commented Aug 29, 2015

Ben Bolker to the rescue! use rmarkdown::render()

achubaty added a commit that referenced this issue Aug 29, 2015
hopefully this does the trick!
achubaty added a commit that referenced this issue Aug 29, 2015
achubaty added a commit that referenced this issue Aug 29, 2015
@achubaty achubaty closed this Aug 29, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants