Add sphinx fresh environment flag #37216
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of work
This PR adds the sphinx fresh environment flag
-E
to our document builds. https://www.sphinx-doc.org/en/master/man/sphinx-build.htmlThis is necessary because when you do not use a fresh environment, if you push two commits in a row, containing the same doctest failure, the second push will not run the failing doctest because the document hasn't changed in the cached environment. Therefore the tests will pass, even when there is a doctest that fails. This assumes both commits run on the same node. This PR will hopefully stop doctest warnings creeping into
main
!The only problem with using
-E
, is it does a rebuild each time, so the doctests will take longer to run. This shouldn't be a problem when we separate the doctests into its own pipeline, and run it on the linux nodes.There is no associated issue.
To test:
Check that the doctests job passes
Reviewer
Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.
Code Review
Functional Tests
Does everything look good? Mark the review as Approve. A member of
@mantidproject/gatekeepers
will take care of it.Gatekeeper
If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.