{"id":13787808,"url":"https://github.com/zenitysec/sphinx-rego","last_synced_at":"2025-05-12T02:30:29.717Z","repository":{"id":52676361,"uuid":"359463379","full_name":"zenitysec/sphinx-rego","owner":"zenitysec","description":"Sphinx extension that automatically documents Open Policy Agent Rego policies","archived":false,"fork":false,"pushed_at":"2023-03-18T10:15:05.000Z","size":100,"stargazers_count":23,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-17T13:51:17.668Z","etag":null,"topics":["conftest","documentation-tool","opa","open-policy-agent","open-policy-agent-python","rego","sphinx"],"latest_commit_sha":null,"homepage":"https://zenity.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zenitysec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-19T13:08:29.000Z","updated_at":"2023-09-13T21:18:45.000Z","dependencies_parsed_at":"2024-08-03T21:01:14.500Z","dependency_job_id":null,"html_url":"https://github.com/zenitysec/sphinx-rego","commit_stats":{"total_commits":40,"total_committers":2,"mean_commits":20.0,"dds":"0.050000000000000044","last_synced_commit":"79474525d61d1184aa42afd49b05e543a42aabd3"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zenitysec%2Fsphinx-rego","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zenitysec%2Fsphinx-rego/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zenitysec%2Fsphinx-rego/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zenitysec%2Fsphinx-rego/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zenitysec","download_url":"https://codeload.github.com/zenitysec/sphinx-rego/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253662521,"owners_count":21944090,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conftest","documentation-tool","opa","open-policy-agent","open-policy-agent-python","rego","sphinx"],"created_at":"2024-08-03T21:00:31.703Z","updated_at":"2025-05-12T02:30:29.359Z","avatar_url":"https://github.com/zenitysec.png","language":"Python","funding_links":[],"categories":["Language and Platform Integrations"],"sub_categories":["Python"],"readme":"sphinx-rego\n===============\n\nA sphinx extension that automatically documents Open Policy Agent Rego policies using the _rego_metadoc_ property.\n\nMaintained by [Zenity](https://zenity.io).\n\n# Example\n\nSee [example/](/example) dir for a documented usage example.\n\n![Sphinx Docs](/example/assets/policy.small.png)\n\n# Prerequisites\n\n- Install [Open Policy Agent](https://www.openpolicyagent.org/docs/latest/#1-download-opa)\n- Make sure the `opa` CLI is available\n\n# Installation:\n\nInstall with PIP\n\n``` commandline\npip3 install sphinx-rego\n```\n\nAdd to Sphinx `conf.py`\n``` python \nextensions += [\"sphinxrego.ext\"]\n```\n\n# Usage Example:\n``` \n.. rego::\n   :policy: policies/**/*.rego\n   :norecursive:\n   :nocustom:\n```\n\n# Arguments:\n\n_policy_: glob pathname to search for .rego policies with _rego_metadoc_ property\n\n_norecursive_: whether to use glob recursive option\n\n_norecursive_: whether to include custom properties\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzenitysec%2Fsphinx-rego","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzenitysec%2Fsphinx-rego","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzenitysec%2Fsphinx-rego/lists"}