| commit | 87038f5d5666acd548bd1ad545b1dbb3c8ff8e7b | [log] [tgz] |
|---|---|---|
| author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu Oct 28 17:31:20 2021 +0000 |
| committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu Oct 28 17:31:20 2021 +0000 |
| tree | 7fc0cfd7422b035d86f3de304342e0fc8a8c11a3 | |
| parent | 6aa2ca0ad925613d818c6bd6736d5f7a5c290b13 [diff] | |
| parent | 64d517f6321fa5674a832e085724929acdc3cb55 [diff] |
Snap for 7862349 from 64d517f6321fa5674a832e085724929acdc3cb55 to t-keystone-qcom-release Change-Id: I4f353fe6109c60ad07c47ad83a7d83b1a0f35c57
tree: 7fc0cfd7422b035d86f3de304342e0fc8a8c11a3
- .bazelci/
- docs/
- stardoc/
- test/
- .gitignore
- AUTHORS
- BUILD
- CODEOWNERS
- CONTRIBUTING.md
- CONTRIBUTORS
- LICENSE
- OWNERS
- README.md
- setup.bzl
- update-release-binary.sh
- update-stardoc-docs.sh
- update-stardoc-tests.sh
- WORKSPACE
README.md
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
Skydoc deprecation
Stardoc is a replacement for the deprecated "Skydoc" documentation generator.
See Skydoc Deprecation for details on the deprecation and migration details.