stardoc

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

This rule is an experimental replacement for the existing skylark_doc rule.

ATTRIBUTES

Name	Description	Type	Mandatory
name	A unique name for this target.	Name	required
aspect_template	The input file template for generating documentation of aspects.	Label	optional
deps	A list of skylark_library dependencies which the input depends on.	List of labels	optional
format	The format of the output file.	String	optional
func_template	The input file template for generating documentation of functions.	Label	optional
header_template	The input file template for the header of the output documentation.	Label	optional
input	The starlark file to generate documentation for.	Label	optional
out	The (markdown) file to which documentation will be output.	Label	required
provider_template	The input file template for generating documentation of providers.	Label	optional
renderer	The location of the renderer tool.	Label	optional
rule_template	The input file template for generating documentation of rules.	Label	optional
semantic_flags	A list of canonical flags to affect Starlark semantics for the Starlark interpretter during documentation generation. This should only be used to maintain compatibility with non-default semantic flags required to use the given Starlark symbols. <br><br>For example, if <code>//foo:bar.bzl</code> does not build except when a user would specify <code>--incompatible_foo_semantic=false</code>, then this attribute should contain “--incompatible_foo_semantic=false”.	List of strings	optional
stardoc	The location of the stardoc tool.	Label	optional
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.	List of strings	optional

_stardoc_impl

Implementation of the stardoc rule.

PARAMETERS

Name	Description	Default Value
ctx	-	none