- Notifications
You must be signed in to change notification settings - Fork4
Sphinx extension that automatically documents Open Policy Agent Rego policies
License
NotificationsYou must be signed in to change notification settings
zenitysec/sphinx-rego
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A sphinx extension that automatically documents Open Policy Agent Rego policies using therego_metadoc property.
Maintained byZenity.
Seeexample/ dir for a documented usage example.
- InstallOpen Policy Agent
- Make sure the
opaCLI is available
Install with PIP
pip3 install sphinx-regoAdd to Sphinxconf.py
extensions+= ["sphinxrego.ext"]
.. rego:: :policy: policies/**/*.rego :norecursive: :nocustom:policy: glob pathname to search for .rego policies withrego_metadoc property
norecursive: whether to use glob recursive option
norecursive: whether to include custom properties
About
Sphinx extension that automatically documents Open Policy Agent Rego policies
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.