ShapeWorks
ShapeWorks copied to clipboard
SCIInstitute
automate mirroring of jupyter notebooks in sw documentation
- The notebooks section hadn't been updated (see pr #1339)
- Is there a way to show these notebooks without needing to manually keep them in sync?
Should now be fixed by PR #1344. For now we have to manually keep them in sync but maybe we should add a new issue for looking into a better way.
Should now be fixed by PR #1344. For now we have to manually keep them in sync but maybe we should add a new issue for looking into a better way.
I would consider this such an issue. Please go ahead and rename it.
Do we want to add this feature of not manually syncing it for this release?
Do we want to add this feature of not manually syncing it for this release?
The docs have been updated to reflect what in there in pr #1344 Let's push trying to fix this to 6.2.
The notebooks are in sync currently, I updated them in the doc PR. I did have to do this manually, we can leave the issue open if we want to brainstorm ways to automate this. If we are okay will the manual copying we can close this.
This application can be used to automate execution of notebooks: https://papermill.readthedocs.io/en/latest/index.html
A script can set parameters and run a notebook, producing output for testing (#1121).
Or current notebook documentation is thorough, but not automated. Using Papermill it may be possible, when the notebooks themselves are sufficiently documented, to automatically create pages that introduce and summarize them, along with providing a screenshot or two. This is less than what we have, but more maintainable as the number of notebooks increases.
Perhaps one or two thorough notebook examples along with automatically generated summary descriptions for the rest will suffice to educate and inform users about these very useful tools.