Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sphinx fresh environment flag #37216

Conversation

robertapplin
Copy link
Contributor

@robertapplin robertapplin commented Apr 25, 2024

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.html

This 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

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

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.

This 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.
@robertapplin robertapplin added the DevOps Issues and pull requests related to DevOps label Apr 25, 2024
@robertapplin robertapplin added this to the Release 6.10 milestone Apr 25, 2024
@robertapplin robertapplin marked this pull request as ready for review April 25, 2024 14:21
@robertapplin robertapplin marked this pull request as draft April 25, 2024 14:23
@robertapplin robertapplin marked this pull request as ready for review April 26, 2024 12:59
@jclarkeSTFC jclarkeSTFC self-assigned this May 3, 2024
@SilkeSchomann SilkeSchomann merged commit 0a3cc42 into mantidproject:main May 3, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DevOps Issues and pull requests related to DevOps
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants