Skip to content

[Essimaging]: Do not allow nbsphinx errors in docs builds#248

Merged
nvaytet merged 3 commits intomainfrom
no-errors-in-imaging-docs
Mar 17, 2026
Merged

[Essimaging]: Do not allow nbsphinx errors in docs builds#248
nvaytet merged 3 commits intomainfrom
no-errors-in-imaging-docs

Conversation

@nvaytet
Copy link
Member

@nvaytet nvaytet commented Mar 17, 2026

For some reason, we had nbsphinx_allow_errors = True enabled in the docs sphinx config.

Note more changes here: we set the LookupTableRelativeErrorThreshold to a default value of Inf in Odin and TBL workflows, to avoid breaking all existing notebooks.

@nvaytet nvaytet added the essimaging Issues for essimaging. label Mar 17, 2026
@nvaytet nvaytet changed the title Do not allow nbshinx errors in docs builds for essimaging [Essimaging]: Do not allow nbshinx errors in docs builds Mar 17, 2026
wf[Filename[OpenBeamRun]] = odin.data.iron_simulation_ob_small()
wf[NeXusDetectorName] = "event_mode_detectors/timepix3"
wf[TimeOfFlightLookupTableFilename] = odin.data.odin_tof_lookup_table()
wf[LookupTableRelativeErrorThreshold] = {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are now set as default in the workflow, so it is no longer needed here.

@nvaytet nvaytet merged commit b2b3e71 into main Mar 17, 2026
4 checks passed
@nvaytet nvaytet deleted the no-errors-in-imaging-docs branch March 17, 2026 09:13
@nvaytet nvaytet changed the title [Essimaging]: Do not allow nbshinx errors in docs builds [Essimaging]: Do not allow nbsphinx errors in docs builds Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

essimaging Issues for essimaging.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants