--- layout: home title: Home stylesheet: home ---

Beautiful Documentation for Build Rules

Stardoc is an easy-to-use documentation generator for Bazel build rules written in Starlark.

(Stardoc is a recent replacement of the documentation generator tool named "Skydoc")

Get Started with Stardoc Take me to Skydoc documentation instead

Python docstrings

Document your Starlark rules alongside their definition.

{% highlight python %} my_rule = rule( implementation = _my_rule_impl, doc = """ Example rule documentation. Example: Here is an example of how to use this rule. """, attrs = { "srcs" : attr.label_list( doc = "Source files used to build this target.", ), "deps" : attr.label_list( doc = "Dependencies for this target.", ), } ) {% endhighlight %}

Convenient Build Rules

Skydoc's own convenient Bazel build rules making it to integrate Skydoc into your build or release pipeline.

{% highlight python %} load("@io_bazel_skydoc//stardoc:stardoc.bzl", "stardoc") stardoc( name = "checkstyle-docs", input = "checkstyle.bzl", out = "checkstyle_doc.md", ) {% endhighlight %}
$ bazel build :checkstyle-docs

Beautiful Documentation

Generate documentation in Markdown.