tweag / rules_sh

Shell rules for Bazel
Apache License 2.0
42 stars 3 forks source link

Use stardoc to automatically generate README.md #32

Closed benradf closed 2 years ago

benradf commented 2 years ago

This change adds targets for automatically generating README.md from stardoc docstrings as requested in #24.

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