| commit | ec43802b541a7a1d6c82514a0d293087aec821c7 | [log] [tgz] |
|---|---|---|
| author | Alexandre Rostovtsev <arostovtsev@google.com> | Tue Apr 23 16:05:45 2024 -0400 |
| committer | GitHub <noreply@github.com> | Tue Apr 23 16:05:45 2024 -0400 |
| tree | 28155b0bc72632ae869066171796c5e8549845db | |
| parent | 39a0c66276a070ff5baad2ebd70809a3b8e979a3 [diff] |
Switch to Bzlmod by default for managing external dependencies (#213) Switch from WORKSPACE-based to bzlmod-based dependency management by default. WORKSPACE-based usage is still supported for users loading Stardoc's versioned distro tarballs, but some packages (`//distro`) in the git development tree will no longer load, and some of Stardoc's own golden tests will no longer pass, when using WORKSPACE. Note that the new default behavior - when using Bzlmod for dependency management - is that Stardoc uses `@stardoc` as its repo name. The legacy WORKSPACE-based setup uses `@io_bazel_stardoc` as repo name. For compatibility with the legacy `WORKSPACE` setup, and for ease of migration, users of Stardoc may load it via `bazel_dep(name = "stardoc", repo_name = "io_bazel_stardoc", ...)` in their `MODULE.bazel`. Fixes #189
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.