-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
include cell execution in documentation of jupyter notebooks #230
Labels
Comments
It turns out that the interactive widgets, which would be the outputs of most cells, are not actually rendered in the documentation output, thus making it useless to store the notebook output in the git repo (or executing the cells on RTD). |
unkcpz
pushed a commit
to unkcpz/aiidalab-widgets-base
that referenced
this issue
Nov 16, 2023
updates: - [github.com/jumanjihouse/pre-commit-hook-yamlfmt: 0.1.1 → 0.2.1](jumanjihouse/pre-commit-hook-yamlfmt@0.1.1...0.2.1) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The documentation of individual widgets is currently done through the notebooks in the
./notebooks
folder.Currently, the code cells of the jupyter notebooks are not executed (also, in order not to bloat the git repository).
For documentation purposes, however, it would be useful to see the results of the execution.
myst-nb lets you specify whether you want the cells executed (it can even cache the result of the output to speed up the process of building the docs), however for many of the notebooks in question one needs a fully functional AiiDA installation.
@chrisjsewell has been looking into getting something like this to work on readthedocs -
we can either wait until progress is made there or we can execute selected cells and store them in the git.
The text was updated successfully, but these errors were encountered: