Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 4.53 KB

stardoc_rule.md

File metadata and controls

43 lines (33 loc) · 4.53 KB
Raw

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

stardoc

stardoc(name, input, out, deps, format, symbol_names, renderer, aspect_template, func_template,
        header_template, table_of_contents_template, provider_template, rule_template,
        repository_rule_template, module_extension_template, footer_template, render_main_repo_name,
        stamp, kwargs)

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

PARAMETERS

Name Description Default Value
name The name of the stardoc target. none
input The starlark file to generate documentation for (mandatory). none
out The file to which documentation will be output (mandatory). none
deps A list of bzl_library dependencies which the input depends on. []
format The format of the output file. Valid values: 'markdown' or 'proto'. "markdown"
symbol_names A 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. []
renderer The location of the renderer tool. Label("@stardoc//stardoc:renderer")
aspect_template The input file template for generating documentation of aspects Label("@stardoc//stardoc:templates/markdown_tables/aspect.vm")
func_template The input file template for generating documentation of functions. Label("@stardoc//stardoc:templates/markdown_tables/func.vm")
header_template The input file template for the header of the output documentation. Label("@stardoc//stardoc:templates/markdown_tables/header.vm")
table_of_contents_template The 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_template The input file template for generating documentation of providers. Label("@stardoc//stardoc:templates/markdown_tables/provider.vm")
rule_template The input file template for generating documentation of rules. Label("@stardoc//stardoc:templates/markdown_tables/rule.vm")
repository_rule_template The input file template for generating documentation of repository rules. Label("@stardoc//stardoc:templates/markdown_tables/repository_rule.vm")
module_extension_template The input file template for generating documentation of module extensions. Label("@stardoc//stardoc:templates/markdown_tables/module_extension.vm")
footer_template The input file template for generating the footer of the output documentation. Optional. None
render_main_repo_name Render labels in the main repository with a repo component (either the module name or workspace name). True
stamp Whether to provide stamping information to templates. False
kwargs Further arguments to pass to stardoc. none