Skydoc
Skydoc

Beautiful Documentation for Build Rules

Skydoc is an easy-to-use documentation generator for Bazel build rules written in Skylark.

Get Started

Python docstrings

Document your Skylark rules with a familiar Python docstring format.

"""An example documentation.

Example:
  Here is an example of how to use this rule.

Args:
  name: A unique name for this rule.
  srcs: Source files used to build this target
  deps: Dependencies for this target.

Outputs:
  output_bin: The output binary.
"""

Convenient Build Rules

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

load("@io_bazel_skydoc//skylark:skylark.bzl",
     "skylark_doc")

skylark_doc(
    name = "checkstyle-docs",
    srcs = ["checkstyle.bzl"],
    format = "html",
)
$ bazel build :checkstyle-docs

Beautiful Documentation

Generate documentation in Markdown or ready-to-serve, beautifully-crafted HTML pages.