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

Images not rendering in docs at https://docs.ropensci.org/MtreeRing/ #5

Open
stefaniebutland opened this issue Jun 13, 2019 · 3 comments

Comments

@stefaniebutland
Copy link
Member

(rOpenSci Community Manager here) rOpenSci has rolled out a new service to automatically build and host documentation for all rOpenSci packages: https://ropensci.org/technotes/2019/06/07/ropensci-docs/

I noticed that the MtreeRing images don't render at https://docs.ropensci.org/MtreeRing/ but they render correctly at https://ropensci.github.io/MtreeRing/.

Tagging @jeroen in case you need help fixing this

@JingningShi
Copy link
Contributor

JingningShi commented Jun 14, 2019

Thanks for your help with this @jeroen .
I updated all image links in the docs/index.html file. These images can now properly display at https://ropensci.github.io/MtreeRing/, but are still unable to render at https://docs.ropensci.org/MtreeRing/. It seems that the rOpenSci docs server will not update itself automatically. I do not know if I should wait a few hours for the update.

@stefaniebutland
Copy link
Member Author

@JingningShi I see the images still do not display at https://docs.ropensci.org/MtreeRing/.
@jeroen are you able to provide advice?

@jeroen
Copy link
Member

jeroen commented Dec 9, 2019

Hi! You need to move your images into the ./man/figures directory and update your readme accordingly.

You can also have a look where other packages store readme.md figures:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants