Starlark rule for stardoc: a documentation generator tool written in Java.

stardoc

Generates documentation for exported starlark rule definitions in a target starlark file.

PARAMETERS

NameDescriptionDefault Value
nameThe name of the stardoc target.none
inputThe starlark file to generate documentation for (mandatory).none
outThe file to which documentation will be output (mandatory).none
depsA list of bzl_library dependencies which the input depends on.[]
formatThe format of the output file. Valid values: ‘markdown’ or ‘proto’."markdown"
symbol_namesA list of symbol names to generate documentation for. These should correspond to the names of rule definitions in the input file. If this list is empty, then documentation for all exported rule definitions will be generated.[]
rendererThe location of the renderer tool.Label("@stardoc//stardoc:renderer")
aspect_templateThe input file template for generating documentation of aspectsLabel("@stardoc//stardoc:templates/markdown_tables/aspect.vm")
func_templateThe input file template for generating documentation of functions.Label("@stardoc//stardoc:templates/markdown_tables/func.vm")
header_templateThe input file template for the header of the output documentation.Label("@stardoc//stardoc:templates/markdown_tables/header.vm")
table_of_contents_templateThe input file template for the table of contents of the output documentation. This is unset by default for backwards compatibility. Use Label("@stardoc//stardoc:templates/markdown_tables/table_of_contents.vm") for the default template.None
provider_templateThe input file template for generating documentation of providers.Label("@stardoc//stardoc:templates/markdown_tables/provider.vm")
rule_templateThe input file template for generating documentation of rules.Label("@stardoc//stardoc:templates/markdown_tables/rule.vm")
repository_rule_templateThe input file template for generating documentation of repository rules.Label("@stardoc//stardoc:templates/markdown_tables/repository_rule.vm")
module_extension_templateThe input file template for generating documentation of module extensions.Label("@stardoc//stardoc:templates/markdown_tables/module_extension.vm")
footer_templateThe input file template for generating the footer of the output documentation. Optional.None
render_main_repo_nameRender labels in the main repository with a repo component (either the module name or workspace name).True
stampWhether to provide stamping information to templates, where it can be accessed via $util.formatBuildTimestamp() and$stamping. Example: Built on $util.formatBuildTimestamp($stamping.volatile.BUILD_TIMESTAMP, "UTC", "yyyy-MM-dd HH:mm") Possible values: stamp = 1: Always provide stamping information, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it. stamp = 0: Do not provide stamping information. stamp = -1: Provide stamping information only if the --stamp flag is set. Stamped targets are not rebuilt unless their dependencies change.-1
kwargsFurther arguments to pass to stardoc.none