BCDA-APS / bluesky_training

Bluesky training, including instrument package
https://bcda-aps.github.io/bluesky_training/
Other
11 stars 0 forks source link

Notice from Sphinx when building locally #115

Closed prjemian closed 1 year ago

prjemian commented 1 year ago
/tmp/git/bluesky_2023_2/lib/python3.10/site-packages/nbformat/__init__.py:93: MissingIDFieldWarning: Code cell is missing an id field, this will become a hard error in future nbformat versions. You may want to use `normalize()` on your notebooks before validations (available since nbformat 5.1.4). Previous versions of nbformat are fixing this issue transparently, and will stop doing so in the future.
  validate(nb)
prjemian commented 1 year ago

StackOverflow has a QA about this: https://stackoverflow.com/questions/66304588/notebook-validation-failed-jupyter

This command will find some candidates for editing as advised: git grep nbformat_minor

prjemian commented 1 year ago

The advice from the link made the problem occur more rather than less. Instead, find exactly which notebooks need attention by forcing a new build and pipe all output to a file:

make -C docs clean html 2>&1 | tee /tmp/log.txt
grep nbformat /tmp/log.txt | wc -l

Then, open each problem notebook in Jupyter and save it. Seems to resolve the problems, at least the first few tested.