Google Git
Sign in
pigweed/third_party/github/bazelbuild/stardoc/3e1a498088d5b531ac10c0f1422655e6ce5efca6
commit
3e1a498088d5b531ac10c0f1422655e6ce5efca6
[log] [tgz]
author
c-parsons <cparsons@google.com>
Fri Oct 11 14:34:26 2019 -0400
committer
GitHub <noreply@github.com>
Fri Oct 11 14:34:26 2019 -0400
tree
9532230278db440a27df8d81e47b48ae630b6d62
parent
42b38f61dd39f514bd7439faea57f12b353b4643 [diff]
Update docs/advanced_stardoc_usage.md

Co-Authored-By: Jin <jin@users.noreply.github.com>
1 file changed
tree: 9532230278db440a27df8d81e47b48ae630b6d62
  1. .bazelci/
  2. docs/
  3. stardoc/
  4. test/
  5. .gitignore
  6. AUTHORS
  7. BUILD
  8. CODEOWNERS
  9. CONTRIBUTING.md
  10. CONTRIBUTORS
  11. LICENSE
  12. README.md
  13. setup.bzl
  14. update-release-binary.sh
  15. update-stardoc-docs.sh
  16. update-stardoc-tests.sh
  17. 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

Skydoc deprecation

Stardoc is a replacement for the deprecated “Skydoc” documentation generator.

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