Stardoc - Starlark Documentation Generator
Stardoc is a documentation generator for Bazel build rules written in Starlark.
Stardoc provides a Starlark rule (stardoc
) that can be used to build documentation
for Starlark rules in Markdown. Stardoc generates one documentation page per .bzl
file.
Skydoc deprecation
NOTE: Stardoc is a replacement for the deprecated "Skydoc" documentation generator.
See Skydoc Deprecation for details on the deprecation, and for some migration tips.
Get Started
- How to set up Stardoc for your project
- Writing docstrings
- How to integrate Stardoc with your build.
About Stardoc
- How to contribute to Stardoc
- See the Stardoc roadmap