Move all required conf.py variables to generated wrapped conf.py so default user conf.py is blank#203
Merged
Conversation
… to add changes. Update README. Signed-off-by: R Kent James <kent@caspia.com> Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later
Signed-off-by: R Kent James <kent@caspia.com> Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later
…rks. Signed-off-by: R Kent James <kent@caspia.com> Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later
tfoote
approved these changes
Oct 3, 2025
tfoote
left a comment
tfoote
left a comment
Member
There was a problem hiding this comment.
Thanks for this it looks like a lot cleaner and easier to maintain in the long run.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Currently, the default user
conf.pythat is generated includes things like the package version, which must then be manually updated to match the version inpackage.xml. Frequently this is not done, so there is a version mismatch.Really there is no reason currently why
version =is recommended inconf.pyas that is set automatically by the wrappingconf.py. But it is unclear to users (and to me for that matter) what is really required in a user-definedconf.py.So this PR moves all of the required settings for
conf.pyto the wrappingconf.py, so that the correct, default userconf.pyis simply blank. That way, package authors can be encouraged to only include changed or extra variables in theirconf.pyThis PR got expanded with a few cleanups that this change encouraged, plus changes in the
READMEto remove unnecessary recommendations to create a userconf.pyin certain circumstances (pus a few drive-by changes toREADMEin the process.