Convert settings into attribute references.#2341
Merged
mhsmith merged 6 commits intobeeware:mainfrom Jun 17, 2025
Merged
Conversation
4 tasks
mhsmith
approved these changes
Jun 17, 2025
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.
One of the review comments of the External Apps PR (#2333) noted that a setting should be hyperlink. That was difficult to do in that context because settings are all referenced as section headings, rather than being marked up as settings.
This PR converts all settings to "attributes", with the module namespace being used to differentiate settings with the same name on different backends.
This could possibly be improved with a custom Sphinx plugin to add a
:setting:directive (or similar), but for now, this meets the goal of having (a) linkable settings, (b) rendered ascode. As we don't have any autodoc content, the:attr:directive is currently unambiguous about what it refers to, so moving to a:setting:directive should be a search-and-replace operation.PR Checklist: