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

🔧 Merge defaults into config earlier #1341

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Oct 28, 2024

Since sphinx-doc/sphinx#12949 it has become more apparent that sphinx detects some sphinx-needs 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 it does not fix is config altered by adding services.
This is difficult, since services are stored on the env, which is not initialised until after the config is checked.

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.
@chrisjsewell chrisjsewell requested a review from danwos October 28, 2024 19:07
Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.96%. Comparing base (4e10030) to head (3a02630).
Report is 82 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1341      +/-   ##
==========================================
+ Coverage   86.87%   87.96%   +1.08%     
==========================================
  Files          56       60       +4     
  Lines        6532     7103     +571     
==========================================
+ Hits         5675     6248     +573     
+ Misses        857      855       -2     
Flag Coverage Δ
pytests 87.96% <100.00%> (+1.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@chrisjsewell chrisjsewell merged commit 94b0273 into master Oct 28, 2024
17 checks passed
@chrisjsewell chrisjsewell deleted the init-config-defaults branch October 28, 2024 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants