docs(guardrails): replace hook placeholders with mkdocstrings directives#872
Merged
Conversation
…ves, remove hook file The <!-- ENUM --> hook approach is not supported by the docs site. Replace each placeholder with a ::: mkdocstrings directive pointing to the source enum class; the class docstring contains the values table so rendering stays automatic without a build hook. Delete docs/hooks/enum_lists.py. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
radugheo
approved these changes
May 22, 2026
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.
What changed?
<!-- ENUM -->placeholder comments indocs/guardrails.mdwith:::mkdocstrings directives pointing to the source enum classes (PIIDetectionEntityType,HarmfulContentEntityType,IntellectualPropertyEntityType) inuipath-pythondocs/hooks/enum_lists.py— the MkDocs build hook used to expand those placeholders is not supported by the docs siteThe enum value tables are now rendered from the class docstrings via mkdocstrings, keeping documentation in sync with the code automatically.
How has this been tested?
Rendered locally via
mkdocs servefrompackages/uipath/inuipath-python. The three entity type sections display a markdown table of values correctly.Are there any breaking changes?