Autogenerate pynest examples from source with sphinx_gallery #1336
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
…autogenerate examples
terhorstd
added
ZC: Documentation
jougs
approved these changes
Nov 23, 2019
steffengraber
approved these changes
Nov 23, 2019
doc/conf.py
Outdated
| MOCK_MODULES = ['numpy', 'scipy', 'matplotlib', 'matplotlib.pyplot', 'pandas'] | ||
| sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) | ||
| # MOCK_MODULES = ['numpy', 'scipy', 'matplotlib', 'matplotlib.pyplot', 'pandas'] | ||
| # sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) | ||
|
|
There was a problem hiding this comment.
I Think it is save to delete this mock magic. I tried building the doc with and without pictures and it works.
|
@jessica-mitchell Sorry for commenting late on this one. I suggest to treat the topology examples in the same way as the other pynest examples. |
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 allows sphinx_gallery to autogenerate examples from pynest/examples/
The mock module in the conf.py file was removed due to a conflict between it and sphinx_gallery; this change should not affect any part of the documentation generation.
The examples that were previously in doc/ are now removed, so we no longer have the duplicate files
And the paths were updated in the examples/index.rst file
The html output should not change.
@heplesser Should I add the topology/examples? I wasn't sure if they need to be updated for 2.18 - The last update mentioned in the README is 2014 NEST 2.6