| commit | 018dee5bd296d81fa3f1eff3a08512d190ff7181 | [log] [tgz] |
|---|---|---|
| author | Fabian Meumertzheim <fabian@meumertzhe.im> | Tue Jun 18 22:34:12 2024 +0200 |
| committer | GitHub <noreply@github.com> | Tue Jun 18 16:34:12 2024 -0400 |
| tree | 1cf001346a0eda51b2b23b433df0de85759163af | |
| parent | aba1a01295094e9df40fc94e355f54e7e98dcd33 [diff] |
Include `load` in summaries (#216) Rules, providers, functions and aspects now have a small `load` statement in their summary. The label in the `load` statement requires forking tests and golden files for --noenable_bzlmod mode; for brevity and maintainability, we are only interested in the following tests for --noenable_bzlmod: * multiple_files * same_level_file * table_of_contents * local_repository (this one needs no forking) --------- Co-authored-by: Alexandre Rostovtsev <arostovtsev@google.com>
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.