Remove make docs race conditions (and other docs fixes) #4635
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
examples and dots are now orthogonal.
KrystalDelusion
changed the title
Call make docs from root
Since `docs/prep` is a prerequisite of `docs`, and should be the *only* prerequisite, calling `make docs` could end up hiding a problem with files missing from the uploaded artifact. Instead, call `make` from the docs directory which should be closer to what will run on RTDs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What are the reasons/motivation for this change?
Fix #4631
Also fix an orphaned page which was one of four warnings triggering read the docs to fail.
Explain how this is achieved.
Removing the
tidytarget from make all was only one part of the issue, the other part was thatgen_examplescalledmake allwhilegen_imagescalledmake dots, where dots was always a subset of all. This could lead to a race condition with theoptcode example where one make could remove%_full.dotwhile the other make file was trying to use it (at least, I think that's what the issue was).The prepare-docs job now also runs
make docs, which should serve as a smoke test for when read the docs is going to fail. If it is, then there is no point triggering it just to watch it fail.If applicable, please suggest to reviewers how they can test the change.
make docs/prep -j[n>1]from top level makefile should run without error.make docsshould also run without error, but as of this writing is expected to fail due to missing help messages in some commands and is reflective of read the docs.