docs: explicitly enumerate configurable params in docs#1683
Merged
Conversation
Signed-off-by: Leon Derczynski <lderczynski@nvidia.com>
Signed-off-by: Leon Derczynski <lderczynski@nvidia.com>
mikemckiernan
approved these changes
Apr 15, 2026
Member
mikemckiernan
left a comment
mikemckiernan
left a comment
There was a problem hiding this comment.
Crafty. Definitely a better human reading experience! Thank you!
Collaborator
jmartin-tech
left a comment
jmartin-tech
left a comment
There was a problem hiding this comment.
I like the add, is there an option we could add to suppress the entry for the attribute that ends up duplicating?
Signed-off-by: Leon Derczynski <lderczynski@nvidia.com>
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 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.
This PR adds to the garak sphinx extension to pick up
DEFAULT_PARAMSand enumerate items & values in a separate section in the class documentation, including a link to how to do config.Verification
List the steps needed to make sure this thing works
pip install -r docs/requirements-docs.txtmake -C docs/source docxdg-open docs/source/index.html(osxopen docs/source/index.html), and make sure you can see what you expect