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

fix readme images #26

Closed
sckott opened this issue Mar 13, 2017 · 2 comments
Closed

fix readme images #26

sckott opened this issue Mar 13, 2017 · 2 comments

Comments

@sckott
Copy link
Contributor

sckott commented Mar 13, 2017

It was recently pointed out to us that some README.html files (generated
from the corresponding README.md ones) on the CRAN package web pages are
incomplete, missing 'local' images not available from the web page and
in most cases actually not even shipped with the package. This clearly
should be changed, so we will move to using '--self-contained' for the
pandoc conversion to ensure that the README.html files are "complete".

Of course, this implies that all 'local' images used in README.md are
needed in the package sources.

If the images are also used for vignettes or Rd files, you can put them
in the 'vignettes' or 'man/figures' directories. Otherwise, please put
them in the top-level 'tools' directory, or a subdirectory of it.

The CRAN incoming checks in r-devel were changed to perform the pandoc
conversion checks with '--self-contained', and hence will warn about
missing images.

Pls ensure completeness in the next regular update of your package.


$`/data/rsync/PKGS/brranching/README.md`
[1] "inst/img/unnamed-chunk-5-1.png" "inst/img/unnamed-chunk-6-1.png"
amoeba added a commit to amoeba/brranching that referenced this issue Oct 8, 2017
@amoeba
Copy link
Contributor

amoeba commented Oct 8, 2017

I took a shot at this one, though I'm inexperienced with some of the finer details. Let me know if I hit the mark.

I was able to reproduce the broken images by building the package, extracting the built package archive and checking the README.html. I removed inst/img (finding an unneeded duplicate image in the process), changed the fig.path option in README.md, rebuilt the package and found the image paths were working fine. PR here.

@sckott
Copy link
Contributor Author

sckott commented Oct 9, 2017

thanks!

@sckott sckott closed this as completed in #29 Oct 9, 2017
sckott pushed a commit that referenced this issue Oct 9, 2017
@sckott sckott added this to the v0.3 milestone Oct 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants