getting_started_stardoc.md

Stardoc is a documentation generator for Bazel build rules written in Starlark.

Stardoc provides a Starlark rule (stardoc) that can be used to build Markdown documentation for Starlark rules, providers, and functions. Starlark generates one documentation page per stardoc target.

If you are new to writing build rules for Bazel, please read the Bazel documentation on writing extensions

Setup

Add a bazel_dep invocation for Stardoc to your MODULE.bazel file, as shown in the MODULE.bazel setup section for the current Stardoc release.

Then add

load("@stardoc//stardoc:stardoc.bzl", "stardoc")

to your BUILD or .bzl file to start using the stardoc rule.

Legacy WORKSPACE setup

Edit your WORKSPACE file as shown in the WORKSPACE setup section for the current Stardoc release.

Then add

load("@io_bazel_stardoc//stardoc:stardoc.bzl", "stardoc")

to your BUILD or .bzl file to start using the stardoc rule.

Note that if you are using WORKSPACE for dependency management, Stardoc's repo name is @io_bazel_stardoc, not @stardoc.

Next Steps

Now you are ready to document your Starlark rules.

• Learn about the docstring format used to document Starlark rules.
• Learn about how you can use Stardoc's build rules to generate your documentation in Markdown format.