search

richfitz / remake

Make-like declarative workflows in R
Other
340 stars 32 forks source link

pkgdown documentation #134

Open krlmlr opened 7 years ago

krlmlr commented 7 years ago

The pkgdown package (ex staticdocs) is gaining traction, I have created a rendering of the current version of the documentation at http://richfitz.github.io/remake/. (Tried to add it to my fork, didn't work.) It would be easy to add the stuff in the doc directory there, too.

I have a script that will push to gh-pages on every commit, which I could add here. You'd need to install the travis package via devtools::install_github("krlmlr/travis@develop") and run travis::use_travis_deploy(tasks = list("travis::task_install_ssh_keys()")) to install Travis infrastructure, I can take care of the rest.

If you don't like it, I'll simply remove the gh-pages branch.

richfitz commented 7 years ago

I have used staticdocs on a number of projects; for example here.

Deploying it off of the travis build is a nice idea, but would you mind setting it up to push onto an orphan branch that never grows? Not sure how hard that is to do with the travis setup, but this is how I usually do it manually.

I am usually very leery of committing outputs and made peace with this approach. After 3 years in Australia I got wary of anything that would make repos bigger than necessary because the internet there was so rubbish...

richfitz commented 7 years ago

So, yes - thank you this is great :)

krlmlr commented 7 years ago

Sure, I can adapt the build script.