| commit | 666b7ba7124b9af9c531c6c5f2013f69b27ea144 | [log] [tgz] |
|---|---|---|
| author | Alexandre Rostovtsev <arostovtsev@google.com> | Wed May 22 15:42:10 2024 -0400 |
| committer | GitHub <noreply@github.com> | Wed May 22 15:42:10 2024 -0400 |
| tree | d3bb0f4aa3ecf3a1843a318c1a5622d1c002191b | |
| parent | be1a9a87e11e7a61ee2ba2240196f5996e07dff1 [diff] |
Render documentation for provider `init` callbacks (#224)
By default, we want the following behavior:
* Custom init callback specified
* The set of parameters for the init callback equals the set of
fields for the provider; and the docs for the init callback's
parameters are either empty or equal to corresponding field docs
* Some init parameters have a default value:
-> Render a single "Fields" table with 3 columns (name, doc,
default value)
* ... otherwise
-> Render a single "Fields" table with 2 columns
* ... otherwise
-> Render two tables - "Constructor parameters" and "Fields" - with
the links from the summary blurb (interfixed with "_init")
leading to the parameters table (not the fields table)
* ... otherwise
-> Trivial case - single "Fields" table (as before).
Fixes #182
Stardoc is a documentation generator for Bazel build rules written in Starlark.
Stardoc provides a Starlark rule (stardoc, see documentation) that can be used to build documentation for Starlark rules in Markdown. Stardoc generates one documentation page per .bzlfile.
Stardoc is a replacement for the deprecated “Skydoc” documentation generator.
See Skydoc Deprecation for details on the deprecation and migration details.
See our future plans for refactoring Stardoc to be more consistent with how Bazel evaluates .bzl files, and what it means for maintenance of this project.
See the maintaner's guide for instructions for cutting a new release.