trevorld / r-argparse

command-line optional and positional argument parser
GNU General Public License v2.0
103 stars 11 forks source link

Clarify rst2pdf installation dependency #4

Closed metasoarous closed 8 years ago

metasoarous commented 10 years ago

Tried to devtools::install_github for latest version, but the installation wasn't able to find rst2pdf, halting the installation. Would be nice to either make this dependency optional or at least more explicit in the documentation.

trevorld commented 10 years ago

It is a build dependency (needed by knitr package to build the vignette) but lacking rst2pdf shouldn't cause a user any installation problems. I uninstalled rst2pdf from my Ubuntu laptop and devtools::install_github still worked fine for me. Could you give me more details about your platform or the error message? Are you using Windows machine by chance?

I suppose I should document the implicit rst2pdf build dependency although knitr could theoretically change the backend at some point in the future.

metasoarous commented 10 years ago

Interesting... I have knitr 1.5 installed, but it was still missing rst2pdf. Often I've noticed when documentation doesn't build properly, the software at least installs, but not the case this time. Not sure why though. As soon as I installed rst2pdf using aptitude (we're running Ubuntu 13.10), install_github went through fine.

If this weird quirk doesn't appear to be reproducible, then don't worry about it. I just thought I would try to be helpful for others.

Thanks for all of you work, and let me know if I can be of further help.