This change adds targets for automatically generating README.md from stardoc docstrings as requested in #24.
Verify that README.md is up-to-date: bazel test //sh/docs:check-readme
Update README.md if necessary: bazel run //sh/docs:update-readme
Due to a stardoc / bzlmod issue these targets are not run for "modules" pipelines on CI. They are also disabled for Windows because it fails to parse the docstring for some reason (I'm guessing line ending differences):
sh\repositories.bzl:4:5 line 22: closing docstring quote should be indented the same as the opening quote
This change adds targets for automatically generating
README.md
from stardoc docstrings as requested in #24.README.md
is up-to-date:bazel test //sh/docs:check-readme
README.md
if necessary:bazel run //sh/docs:update-readme
Due to a stardoc / bzlmod issue these targets are not run for "modules" pipelines on CI. They are also disabled for Windows because it fails to parse the docstring for some reason (I'm guessing line ending differences):