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
Allow extensions to detect freshenv builds #12358
Open
chrisjsewell
wants to merge
5
commits into
sphinx-doc:master
Choose a base branch
from
chrisjsewell:extension-access-E
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
Some extensions cache data outside of the `BuildEnvironment` (usually for memory/performance reasons). For these extensions it would be helpful to detect when `sphinx-build -E` has been called, which in essence suggests the user wishes to remove cached data before building.
(Also added a docstring for the |
picnixz
reviewed
May 7, 2024
chrisjsewell
commented
May 7, 2024
chrisjsewell
commented
May 7, 2024
chrisjsewell
commented
May 7, 2024
AA-Turner
changed the title
👌 Allow extensions to detect freshenv builds
Allow extensions to detect freshenv builds
May 7, 2024
picnixz
approved these changes
May 21, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's fine. At least, I don't have any comments.
Ideally, I would like to improve even more the comments for the constructor with examples & co. but this should be done in another PR and more at the rst level.
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.
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.