Configure Sphinx gallery to copy files from pynest/examples
#3284
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
jessica-mitchell
added
S: Normal
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.
This PR adjusts the configuration for Sphinx gallery so it now copies additional files from
pynest/examples.This makes it easier to keep all files related to the example together and link to them appropriately.
This means the function for copying hpc_benchmark_connectivity.svg can be removed from
conf.pyThis also fixes #3246
Note however, files (txt, images etc) required for Python examples, need to be somehow linked to in the appropriate script. For eprop handwriting text file - it is added as a
:download:link.In the case of Sonata, there is an additional folder with many types of files. These are not copied and a direct link to the repo needs to be used. Sphinx gallery does not support >1 subfolders. (see mention here)
Thus, when creating Python scripts and additional data or image files need to be used, care must be taken that links are included.