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

XSPlot Example not rendering images on RTD #123

Closed
drewejohnson opened this issue Apr 20, 2018 · 6 comments
Closed

XSPlot Example not rendering images on RTD #123

drewejohnson opened this issue Apr 20, 2018 · 6 comments
Assignees
Milestone

Comments

@drewejohnson
Copy link
Collaborator

Summary of issue

The images for the XSPlot reader are either not found or failing to load on readthedocs

Code for reproducing the issue

Follow the link

Expected outcome

Display the images

This could maybe be fixed by moving the plots into the docs folder and changing the links.

@drewejohnson
Copy link
Collaborator Author

@gridley Would you be able to take a look at this? I think rtd isn't rendering your example properly

@gridley
Copy link
Contributor

gridley commented May 1, 2018 via email

@gridley
Copy link
Contributor

gridley commented May 1, 2018 via email

@drewejohnson
Copy link
Collaborator Author

Good luck 🏆

@drewejohnson
Copy link
Collaborator Author

In regards to the missing python code blocks, I may have a solution. I think the issue comes from the .. code:: ipython3 blocks. The ipython3 lexer is finicky depending upon install procedure and may not exist on readthedocs.

As for the images, those should be moved to docs/examples/images and all links in the .rst file should be changed to point towards the location in that folder. My guess is that sphinx only clones what is inside the docs directory, and those images would not exist given the case.

I will add these comments to #125. Once this is fixed and the docs are properly built, we can push out a release with the xsplot reader 👌

@gridley
Copy link
Contributor

gridley commented May 9, 2018 via email

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