Skip to content

Readthedocs build CI job should report failure if any jupyter notebook fails #1901

Open

Description

@Sevans711

Currently the readthedocs build CI job which runs in PRs reports success as long as it can successfully generate a preview of all the docs pages. This does not require all jupyter notebook examples' cells to all run successfully, and in fact this can often lead to cells' outputs showing error reports directly in the docs, which go unnoticed until someone reports them, such as in #1542 and #1887 (review).

The readthedocs CI job settings should be updated to instead report a failure (red X instead of green check) when any of the jupyter notebook example cells crash. (Though, if possible, it would be nice if a readthedocs build preview could still be shown even when reporting failure, since the previews currently do help quite a bit with debugging, once a bug has actually been spotted in the first place.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    CIContinuous IntegrationbugSomething isn't working

    Type

    No type

    Fields

    Priority

    None yet

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions