Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / stardoc / 45ae581e07e951cc9863007bddeadab89a883f2c
commit45ae581e07e951cc9863007bddeadab89a883f2c[log] [tgz]
authorc-parsons <cparsons@google.com>Mon Mar 18 17:56:35 2019 -0400
committerGitHub <noreply@github.com>Mon Mar 18 17:56:35 2019 -0400
treebb9d5211531026ac0f973c7293ba9bd91bdaaa29
parentf57c9880b9033241ad341ffc17a88d804cdfde3a [diff]
Use a prebuilt Stardoc release binary (#172)

Instead of forcing users to depend on @io_bazel so that Stardoc
is built from source for each invocation, a prebuilt Stardoc binary will be included
in this repository, and updated on release cuts.

This also eliminates buggy behavior when Stardoc and @io_bazel repositories
are out of sync in a user's workspace.

Closes #170
6 files changed
tree: bb9d5211531026ac0f973c7293ba9bd91bdaaa29
  1. .bazelci/
  2. site/
  3. skydoc/
  4. skylark/
  5. stardoc/
  6. test/
  7. .gitignore
  8. AUTHORS
  9. BUILD
  10. CODEOWNERS
  11. CONTRIBUTING.md
  12. CONTRIBUTORS
  13. LICENSE
  14. README.md
  15. serve-docs.sh
  16. setup.bzl
  17. skydoc-screenshot.png
  18. update-release-binary.sh
  19. 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) that can be used to build documentation for Starlark rules in Markdown. Stardoc generates one documentation page per .bzl file.

Skydoc deprecation

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

See Skydoc Deprecation for details on the deprecation, and for some migration tips.

Get Started

About Stardoc