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.
- How to set up Stardoc for your project
- Writing docstrings
- How to integrate Stardoc with your build.
- See also Advanced Topics.
- Stardoc rule reference.
- How to contribute to Stardoc
Stardoc is a replacement for the deprecated "Skydoc" documentation generator.
See Skydoc Deprecation for details on the deprecation and migration details.