Skip to content

docs reference *.html

Yitao Li edited this page Sep 29, 2020 · 5 revisions
  • Those are essentially everything generated by pkgdown::build_site() minus all the javascript and svg files, etc under docs/

  • How to update those files:

    cd sparklyr

    mv docs /tmp # avoid pkgdown complaining docs was not generated by pkgdown

    Rscript -e 'pkgdown::build_site()' # everything that is not docs/reference/*.html will be ignored, see .gitignore

  • What to do if you see x [ENOENT] Failed to remove '/tmp/RtmpqCYhgl/file170415d6aac9.html': no such file or directory or similar mumble jumbles and nothing is working: check whether you have an up-to-date and working pandoc installation in your system, or any other run-time dependency of pkgdown being missing. It's a shame that some of those error messages are far from being self-explanatory at the moment :/

  • Update _pkgdown.yml to specify which sections to place the newly created topics from the previous step (this is important, because otherwise the new topics would not show up on spark.rstudio.com)

  • Finally, sync the updates to https://github.com/rstudio/spark.rstudio.com, using instructions in https://github.com/rstudio/spark.rstudio.com#instructions