search

neuropsychology / NeuroKit

NeuroKit2: The Python Toolbox for Neurophysiological Signal Processing
https://neuropsychology.github.io/NeuroKit
MIT License
1.53k stars 410 forks source link

[Fix] Documentation Image Dependency #1010

Closed DerAndereJohannes closed 2 months ago

DerAndereJohannes commented 2 months ago

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: image-fix

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.

DominiqueMakowski commented 2 months ago

Hi @DerAndereJohannes sorry for the delay, thanks so much for that!!