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

Tell users when a template causes build invalidation #12746

Merged
merged 4 commits into from
Aug 8, 2024

Conversation

larsoner
Copy link
Contributor

@larsoner larsoner commented Aug 7, 2024

Subject: Adding info about what template is problematic when rebuilds happen.

Feature or Bugfix

  • Feature

Purpose

I was generating a template on the fly which was causing everything to be out of date. So I added a logging message for that:

building [html]: template avatars.html is newer (2024-08-06 20:36:50.84) than previous build info (2024-08-06 20:17:22.360), all docs will be out of date

allowing me to easily see that the avatars.html that we generate at the start of each doc build should more carefully be updated (or perhaps not be a template file actually!).

Relates

Broken away for simplicity from #12741 as suggested by @AA-Turner .

sphinx/builders/html/__init__.py Outdated Show resolved Hide resolved
sphinx/builders/html/__init__.py Outdated Show resolved Hide resolved
@AA-Turner AA-Turner changed the title ENH: Emit info about template being newer Tell users when a template causes build invalidation Aug 8, 2024
@AA-Turner AA-Turner added type:enhancement enhance or introduce a new feature builder:html html theme labels Aug 8, 2024
@AA-Turner AA-Turner modified the milestones: 8.0.x, 8.x Aug 8, 2024
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner AA-Turner merged commit 4f270a5 into sphinx-doc:master Aug 8, 2024
19 checks passed
@larsoner larsoner deleted the why2 branch August 8, 2024 18:21
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 8, 2024
@AA-Turner AA-Turner modified the milestones: 8.x, 8.1.0 Oct 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
builder:html html theme type:enhancement enhance or introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants