History

liiir1985 7f62dcda9f initial		2024-06-22 20:45:49 +08:00
..
.bazelci	initial	2024-06-22 20:45:49 +08:00
docs	initial	2024-06-22 20:45:49 +08:00
stardoc	initial	2024-06-22 20:45:49 +08:00
test	initial	2024-06-22 20:45:49 +08:00
AUTHORS	initial	2024-06-22 20:45:49 +08:00
BUILD	initial	2024-06-22 20:45:49 +08:00
CODEOWNERS	initial	2024-06-22 20:45:49 +08:00
CONTRIBUTING.md	initial	2024-06-22 20:45:49 +08:00
CONTRIBUTORS	initial	2024-06-22 20:45:49 +08:00
LICENSE	initial	2024-06-22 20:45:49 +08:00
OWNERS	initial	2024-06-22 20:45:49 +08:00
README.md	initial	2024-06-22 20:45:49 +08:00
WORKSPACE	initial	2024-06-22 20:45:49 +08:00
setup.bzl	initial	2024-06-22 20:45:49 +08:00
update-release-binary.sh	initial	2024-06-22 20:45:49 +08:00
update-stardoc-docs.sh	initial	2024-06-22 20:45:49 +08:00
update-stardoc-tests.sh	initial	2024-06-22 20:45:49 +08:00

README.md

Stardoc - Starlark Documentation Generator

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.

Get Started

How to set up Stardoc for your project
Writing docstrings
How to integrate Stardoc with your build.
See also Advanced Topics.

About Stardoc

Stardoc rule reference.
How to contribute to Stardoc

Skydoc deprecation

Stardoc is a replacement for the deprecated "Skydoc" documentation generator.

See Skydoc Deprecation for details on the deprecation and migration details.