| commit | 056ba3bf3a3f516448eed2774a7adcd283775b10 | [log] [tgz] |
|---|---|---|
| author | Alexandre Rostovtsev <arostovtsev@google.com> | Wed Aug 02 14:53:54 2023 -0400 |
| committer | GitHub <noreply@github.com> | Wed Aug 02 14:53:54 2023 -0400 |
| tree | 1447a85fd8af835905cc50e115555a2e7e3cfccb | |
| parent | 4736754e587ed3f69211fc8ddfb7f79798d2d95d [diff] |
Enable render_main_repo_name by default with starlark_doc_extract (#168) Most Stardoc users are probably documenting their rules for users from other repos - so we ought to render labels in the repo being documented with the repo name.
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.