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

HTML builder: toctree reliability during parallel builds #12886

Conversation

jayaddison
Copy link
Contributor

Feature or Bugfix

  • Bugfix

Purpose

Detail

  • Extend the test coverage on the toctree-glob testroot to enable a parallelised test where the alabaster theme is used (required so that a navigation sidebar, where the problem manifests, is included in the output)

Relates

The test case added here is expected to fail intermittently to begin
with; it is added to uncover what seems to be a race condition that
occurs during some but not all parallelised builds.
@jayaddison
Copy link
Contributor Author

This test case does pass intermittently for me locally, and that's what I was hoping to demonstrate with a few small commits here. It seems I may be wasting CI compute resources though; the test always fails when run on a host with a single core available, so.. perhaps these are always going to fail.

@jayaddison
Copy link
Contributor Author

I'll push one more commit, and then I'll give up on demonstrating the intermittent nature of this using CI and will move on to investigating possible fixes.

@jayaddison
Copy link
Contributor Author

Confusingly to me, the test_parallel_toctree test case added here now fails reliably on my multi-core local machine. It was previously failing intermittently in a way that I believe confirmed something about the non-deterministic toctree construction behaviour.

Because this changeset now seems invalid (it doesn't prove any nondeterministic behaviour) I'm going to close this pull request.

@jayaddison jayaddison closed this Sep 28, 2024
@jayaddison jayaddison deleted the issue-6714/parallelised-toctree-test-coverage branch September 28, 2024 17:04
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
1 participant