gh-365: upload HTML rendering of notebooks as artifact #367
Conversation
Saransh-cpp
added
documentation
Saransh-cpp
force-pushed
the
saransh/run-nb-on-rtd
branch
from
0bde94b
to
cba97ff
Compare
Saransh-cpp
changed the title
Saransh-cpp
force-pushed
the
saransh/run-nb-on-rtd
branch
from
cba97ff
to
614f214
Compare
|
Great work @Saransh-cpp! Can you revert the changes to the .ipynb files, which will be nothing but updated timestamps and redrawn plots? |
| - name: Run examples | ||
| run: nox -s examples | ||
| - name: Generate HTML | ||
| run: nox -s examples -- html | ||
| - uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: Examples | ||
| path: examples/**/*.html |
There was a problem hiding this comment.
I think this now executes all of the examples twice: once with jupyter execute examples/**/*.ipynb and once with jupyter nbconvert --execute. You could either remove the first step, or I believe you can remove --execute from the second step.
|
Could you add a dummy file somewhere that triggers the "Test examples" step, to be removed before merging? |
Could we add this to repos:
- repo: https://github.com/kynan/nbstripout
rev: 0.7.1
hooks:
- id: nbstripout
args:
- --keep-output |
Have added this and raised #380 |
The workflows now produce an HTML rendering of the notebook and upload it as artifact. I have tweaked the nox session to help with this. All the notebooks have been rerun to update the outputs with the recent changes.
Closes: #365