ConvertAnnotationsToSections generates a more convenient struct that can be used to generate the doc First concern is to build a coherent title structure; the ideal case is that each package and each rule has a doc, but this is not guaranteed.

ExternalTemplate is a functional option to override the documentation template When overriding the template, we assume it is located on the host file system.

GenerateDocument generate a documentation file for a given module A single page is generated for the module located in the indicated directory this includes all package, subpackages and rules of the provided path.

ParseRegoWithAnnotations parse the rego in the indicated directory.

RenderDocument takes a slice of Section and generate the markdown documentation either using the default embedded template or the user provided template.

Section is a sequential piece of documentation comprised of ast.Annotations and some pre-processed fields This struct exist because some fields of ast.Annotations are not easy to manipulate in go-template.

TemplateConfig represent the location of the template file(s).

Document represent a page of the documentation.

TemplateKind helps us to select where to find the template.