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

Log differences in configuration from the pickled environment #12949

Merged
merged 9 commits into from
Oct 8, 2024

Conversation

AA-Turner
Copy link
Member

cc: @larsoner

This is an attempt towards #12741, displaying what has changed in the config between the pickled environment and conf.py.

This should have a test and CHANGES entry before merge, but interested in your thoughts.

A

@AA-Turner AA-Turner mentioned this pull request Oct 6, 2024
@AA-Turner AA-Turner requested a review from picnixz October 6, 2024 21:22
sphinx/environment/__init__.py Outdated Show resolved Hide resolved
sphinx/environment/__init__.py Outdated Show resolved Hide resolved
@AA-Turner AA-Turner added this to the 8.1.0 milestone Oct 7, 2024
@AA-Turner AA-Turner merged commit 886bb94 into sphinx-doc:master Oct 8, 2024
23 checks passed
@AA-Turner AA-Turner deleted the config/save-config branch October 8, 2024 05:25
@larsoner
Copy link
Contributor

larsoner commented Oct 8, 2024

Sorry I never responded, seems like it should help, thanks @AA-Turner !

@AA-Turner
Copy link
Member Author

No worries, thank you for the idea and discussion @larsoner.

A

chrisjsewell added a commit to useblocks/sphinx-needs that referenced this pull request Oct 28, 2024
Since sphinx-doc/sphinx#12949 it has become more apparent that sphinx detects some configuration values as changed when they have not.
This fixes most of these by merging user defined config with built-in defaults earlier in the processing.

The only thing is does not fix is config altered by adding services. This is difficult, since services are stored on the `env`, which is not initialised until agter the config is checked.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants