[Fix] Documentation Image Dependency #1010
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added pickleshare as dependency in the docs-build workflow
|
Hi @DerAndereJohannes sorry for the delay, thanks so much for that!! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The example images were not working for a while on the documentation website and I was curious as to what was wrong. It turns out that ipython at some point made the pickleshare dependency optional which meant that it was not automatically installed in the doc building workflow. I found the solution here on this issue ipython/ipython#14367. The solution is either to add pickleshare as a dependency or to update IPython. In this pull request I have simply gone with adding pickleshare as a dependency to get the images back online asap. Updating the remaining dependencies would be a topic for a different thread.
Description
This PR fixes the issue #999 and allows users to be able to see the examples again on the documentation website. Here is the example from the issue with the actual image to see the result:
Proposed Changes
I added pickleshare as a dependency for the docs-build to allow for the doc image files to be stored in the correct location.