Starlark rule for stardoc: a documentation generator tool written in Java.
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. | [] |
| semantic_flags | A list of canonical flags to affect Starlark semantics for the Starlark interpreter during documentation generation. This should only be used to maintain compatibility with non-default semantic flags required to use the given Starlark symbols. For example, if //foo:bar.bzl does not build except when a user would specify --incompatible_foo_semantic=false, then this attribute should contain “--incompatible_foo_semantic=false”. | [] |
| stardoc | The location of the legacy Stardoc extractor. Ignored when using the native starlark_doc_extract rule. | Label("@io_bazel_stardoc//stardoc:prebuilt_stardoc_binary") |
| renderer | The location of the renderer tool. | Label("@io_bazel_stardoc//stardoc:renderer") |
| aspect_template | The input file template for generating documentation of aspects | Label("@io_bazel_stardoc//stardoc:templates/markdown_tables/aspect.vm") |
| func_template | The input file template for generating documentation of functions. | Label("@io_bazel_stardoc//stardoc:templates/markdown_tables/func.vm") |
| header_template | The input file template for the header of the output documentation. | Label("@io_bazel_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("@io_bazel_stardoc//stardoc:templates/markdown_tables/provider.vm") |
| rule_template | The input file template for generating documentation of rules. | Label("@io_bazel_stardoc//stardoc:templates/markdown_tables/rule.vm") |
| repository_rule_template | The input file template for generating documentation of repository rules. This template is used only when using the native starlark_doc_extract rule. | Label("@io_bazel_stardoc//stardoc:templates/markdown_tables/repository_rule.vm") |
| module_extension_template | The input file template for generating documentation of module extensions. This template is used only when using the native starlark_doc_extract rule. | Label("@io_bazel_stardoc//stardoc:templates/markdown_tables/module_extension.vm") |
| footer_template | The input file template for generating the footer of the output documentation. Optional. | None |
| use_starlark_doc_extract | Use the native starlark_doc_extract rule if available. | True |
| render_main_repo_name | Render labels in the main repository with a repo component (either the module name or workspace name). This parameter is used only when using the native starlark_doc_extract rule. | True |
| stamp | Whether to provide stamping information to templates. | False |
| kwargs | Further arguments to pass to stardoc. | none |