Google Git
Sign in
pigweed / third_party / github / bazelbuild / stardoc / 0fd1df740548bdbc9d22ee1790793293947fab41
commit0fd1df740548bdbc9d22ee1790793293947fab41[log] [tgz]
authorAlexandre Rostovtsev <arostovtsev@google.com>Tue Aug 29 13:01:16 2023 -0400
committerGitHub <noreply@github.com>Tue Aug 29 13:01:16 2023 -0400
treec67f12e14c7d1401aa0b79d8bf71060a9014e7ab
parentaebbedb4a43a6542d00176a1427d73bd6af2e63b [diff]
Maintainer guide improvements (#187)

* Add blurb about repository fetch errors
* Fix BCR text
* Recommend adding a commented MODULE.bazel setup block and uncommenting (easier than copy/pasting it later)

Fixes #186
5 files changed
tree: c67f12e14c7d1401aa0b79d8bf71060a9014e7ab
  1. .bazelci/
  2. distro/
  3. docs/
  4. src/
  5. stardoc/
  6. test/
  7. .bazelignore
  8. .bazelrc
  9. .gitignore
  10. AUTHORS
  11. BUILD
  12. CHANGELOG.md
  13. CODEOWNERS
  14. CONTRIBUTING.md
  15. CONTRIBUTORS
  16. deps.bzl
  17. legacy_maven_install.json
  18. LICENSE
  19. maven_install.json
  20. MODULE.bazel
  21. README.md
  22. rules_jvm_external.patch
  23. setup.bzl
  24. update-release-binary.sh
  25. update-stardoc-docs.sh
  26. update-stardoc-tests.sh
  27. version.bzl
  28. WORKSPACE
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.