stardoc
stardoc copied to clipboard
bazelbuild
Stardoc: Starlark Documentation Generator
Rules, providers, functions and aspects now have a `load` statement in their summary. Aspects additionally include a copyable `--aspects` flag. Fixes #95
Since we don't include anything from //distro/... in the distro tarball itself. Note that skylib's distro packaging follows the same logic.
Whenever I start using a new Starlark rule, the first step is to `load()` it in my BUILD file. Therefore it would be handy if the Stardoc output for each...
We generate API docs for bazel build language objects which include a doc field (such as rules, providers, and aspects) or have a docstring set by convention (modules, functions); but...
It's not always practical to add a dependency on the bzl files that come from third party dependencies. `stardoc` should allow documentation to be generated without introspecting deeply into dependencies....
Hi, the [Pigweed](https://pigweed.dev) team is interested in using stardoc. One problem: we use [Sphinx](https://www.sphinx-doc.org) and write our docs in [reStructuredText](https://docutils.sourceforge.io/rst.html). Could you all implement reST support? Or would you be...
I want to be able to write a docstring that presents as The attribute foo must be one of: - a: ... - b: ... The markdown renderer puts attributes...
A common use case is: - //my/rules:foo.bzl, the public interface to `foo()` - //my/rules/private:foo.bzl: actually defines `foo()` - //my/rules/docs/BUILD has a set of stardoc rules to make a comprehensive doc...
One pattern in use in repos is to override a rule with a macro so that additional targets can be generated without needing to rewrite existing callers. An example of...
As explained in https://github.com/bazelbuild/bazel/issues/7977, there's a common use case for macros which serve as thin wrappers on rule invocations. In such cases, it's inconvenient and maintenance-heavy to manually mirror rule...
