commit | af19cfea776807124ef0db480328459aec1e0d6b | [log] [tgz] |
---|---|---|
author | Alexandre Rostovtsev <arostovtsev@google.com> | Thu Aug 03 10:36:35 2023 -0400 |
committer | GitHub <noreply@github.com> | Thu Aug 03 10:36:35 2023 -0400 |
tree | 40d6862a3cb16022c8364efb8148b1bb6049d640 | |
parent | b8856b4ceb783c2e8ff77b08525ce1d91711d5c2 [diff] |
Fix non-bzlmod distribution (#172) Since we are building the renderer from source and using rules_jvm_external to pull in Maven deps, the WORKSPACE setup for a user of Stardoc is now significantly more complicated; the user will now need to do the multi-step rules_jvm_external initialization and maven_install. For convenience, let's wrap maven_install in a macro - and finally split out the legacy-test-only maven deps into their own .json file and repo. Update stardoc_repositories to pull in all the new deps we need to build Java code. Update maintainer guide.
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 .bzl
file.
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.