Doctests do not remove built files if they fail #3389

[shubhambhar007]

Description

As pointed by @agriyakhetarpal , in case of failure of doctests, built files (inside the docs/build/ folder) are not deleted.
We also have to ensure deletion in case of successful doctests. I added a finally block for the same and put the subprocess call in a try block.

Fixes #3389

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

• [❌ ] New feature (non-breaking change which adds functionality)
• [❌] Optimization (back-end change that speeds up the code)
• [✅] Bug fix (non-breaking change which fixes an issue)

Key checklist:

• [✅ ] No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
• [✅] All tests pass: $ python run-tests.py --all (or $ nox -s tests)
• [✅] The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

• [✅] Code is commented, particularly in hard-to-understand areas
• [NA ] Tests added that prove fix is effective or that feature works

[shubhambhar007]

[agriyakhetarpal]

Thanks for the fix, @shubhambhar007! Looks good, one small suggestion.

[shubhambhar007]

@agriyakhetarpal i think i force pushed on top of your commit , didnt check the thread😅
Please review once .

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c24383c) 99.59% compared to head (4fe3e00) 99.59%.
Report is 12 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3655   +/-   ##
========================================
  Coverage    99.59%   99.59%           
========================================
  Files          258      258           
  Lines        20797    20798    +1     
========================================
+ Hits         20712    20713    +1     
  Misses          85       85           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[agriyakhetarpal]

I think it was the same suggestion that I updated your branch with, we should be fine – thanks! Looks like the missing coverage is unrelated.

[shubhambhar007]

I think it was the same suggestion that I updated your branch with, we should be fine – thanks! Looks like the missing coverage is unrelated.

Yes ,i thought so too, the subrpocess call is being fed arguments by us itself and is not subject to any outside code injection, should be fine in my opinion :D .
Thanks!

[arjxn-py]

Looks Good, thanks @shubhambhar007

[arjxn-py]

Example notebook tests failing doesn't look like a cause of this PR, should we re-run jobs?

[agriyakhetarpal]

Example notebook tests failing doesn't look like a cause of this PR, should we re-run jobs?

I did so just now, it seems that #3492 broke something even though it shouldn't have