Allow extensions to detect freshenv builds #12358
Open
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.
Some extensions cache data outside of the
BuildEnvironment
(usually for memory/performance reasons). For these extensions it would be helpful to detect whensphinx-build -E
has been called, which in essence suggests the user wishes to remove cached data before building.This PR adds the
Sphinx.fresh_env_used
public property, exposingSphinx._fresh_env_used
in an immutable manner.Note, you could create some form of callback event for this, but I feel this is probably overkill and the property will suffice.