Google Git
Sign in
pigweed / third_party / github / bazelbuild / stardoc / HEAD / .
tree: be29fa379ce90d8896e01bc71bb768bb70e97619 [path history] [tgz]
  1. .bazelci/
  2. .bcr/
  3. .github/
  4. distro/
  5. docs/
  6. src/
  7. stardoc/
  8. test/
  9. .bazelignore
  10. .bazelrc
  11. .gitignore
  12. AUTHORS
  13. BUILD
  14. CHANGELOG.md
  15. CODEOWNERS
  16. CONTRIBUTING.md
  17. CONTRIBUTORS
  18. deps.bzl
  19. LICENSE
  20. maven_install.json
  21. MODULE.bazel
  22. README.md
  23. setup.bzl
  24. update-release-binary.sh
  25. update-stardoc-docs.sh
  26. update-stardoc-tests.sh
  27. version.bzl
  28. WORKSPACE
  29. WORKSPACE.bzlmod
README.md

Stardoc - Starlark Documentation Generator

Build status

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

About 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.