| .. | ||
| .bazelci | ||
| distro | ||
| docs | ||
| stardoc | ||
| test | ||
| .bazelrc | ||
| .gitignore | ||
| AUTHORS | ||
| BUILD | ||
| CHANGELOG.md | ||
| CODEOWNERS | ||
| CONTRIBUTING.md | ||
| CONTRIBUTORS | ||
| LICENSE | ||
| METADATA | ||
| OWNERS | ||
| README.md | ||
| setup.bzl | ||
| update-release-binary.sh | ||
| update-stardoc-docs.sh | ||
| update-stardoc-tests.sh | ||
| version.bzl | ||
| WORKSPACE | ||
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
Project Status
Skydoc deprecation
Stardoc is a replacement for the deprecated "Skydoc" documentation generator.
See Skydoc Deprecation for details on the deprecation and migration details.
Future plans
See our future plans for refactoring Stardoc to be more consistent with how Bazel evaluates .bzl files, and what it means for maintenance of this project.
Maintainer's guide
See the maintaner's guide for instructions for cutting a new release.