| commit | f40819fd48193987f8cd22d724fbbab2a7aaf322 | [log] [tgz] |
|---|---|---|
| author | Alexandre Rostovtsev <arostovtsev@google.com> | Fri May 31 12:23:59 2024 -0400 |
| committer | GitHub <noreply@github.com> | Fri May 31 12:23:59 2024 -0400 |
| tree | 10688cc8d21e5b5f75b2dd0dd2d69a2ca2bdc362 | |
| parent | 4644386b36253da4436bb961ed1f5fbcc8c15101 [diff] |
Refactor param rendering in summary line (#230) Switch from plain strings to a new Param class with separate name and anchor, and transform every param-like entity (FunctionParamInfo, AttributeInfo, or ProviderFieldInfo) into it. This commit does not change rendering result in any way, but sets us up to make the following possible: * create a Param without a link (e.g. a "*" separator) * add leading "*"/"**" to the names - but not anchor links! - of args/kwargs * reorder *kwargs and keyword-only params when rendering summaries for functions and provider constructors Working towards https://github.com/bazelbuild/stardoc/issues/225
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.