| Name | Date | Size | #Lines | LOC | ||
|---|---|---|---|---|---|---|
| .. | - | - | ||||
| .bazelci/ | 03-May-2024 | - | 25 | 23 | ||
| docs/ | 03-May-2024 | - | 647 | 479 | ||
| stardoc/ | 03-May-2024 | - | 582 | 492 | ||
| test/ | 03-May-2024 | - | 3,389 | 2,375 | ||
| .gitignore | D | 03-May-2024 | 225 | 20 | 19 | |
| AUTHORS | D | 03-May-2024 | 305 | 10 | 7 | |
| BUILD | D | 03-May-2024 | 186 | 11 | 8 | |
| CODEOWNERS | D | 03-May-2024 | 29 | 2 | 1 | |
| CONTRIBUTING.md | D | 03-May-2024 | 1.4 KiB | 28 | 22 | |
| CONTRIBUTORS | D | 03-May-2024 | 586 | 16 | 14 | |
| LICENSE | D | 03-May-2024 | 11.1 KiB | 203 | 169 | |
| OWNERS | D | 03-May-2024 | 166 | 7 | 5 | |
| README.md | D | 03-May-2024 | 1.2 KiB | 31 | 19 | |
| WORKSPACE | D | 03-May-2024 | 2.6 KiB | 71 | 60 | |
| setup.bzl | D | 03-May-2024 | 1.7 KiB | 41 | 36 | |
| update-release-binary.sh | D | 03-May-2024 | 1.4 KiB | 39 | 13 | |
| update-stardoc-docs.sh | D | 03-May-2024 | 1 KiB | 30 | 6 | |
| update-stardoc-tests.sh | D | 03-May-2024 | 1.9 KiB | 48 | 20 |
README.md
1# Stardoc - Starlark Documentation Generator 2 3[](https://buildkite.com/bazel/stardoc) 4 5Stardoc is a documentation generator for [Bazel](https://bazel.build) build rules 6written in [Starlark](https://bazel.build/docs/skylark/index.html). 7 8Stardoc provides a Starlark rule (`stardoc`, see [documentation](docs/stardoc_rule.md)) that can 9be used to build documentation for Starlark rules in Markdown. Stardoc generates one documentation 10page per `.bzl`file. 11 12## Get Started 13 14* How to [set up Stardoc for your project](docs/getting_started_stardoc.md) 15* Writing [docstrings](docs/writing_stardoc.md) 16* How to [integrate Stardoc with your build](docs/generating_stardoc.md). 17* See also [Advanced Topics](docs/advanced_stardoc_usage.md). 18 19## About Stardoc 20 21* Stardoc [rule reference](docs/stardoc_rule.md). 22* How to [contribute to Stardoc](docs/contributing.md) 23 24## Skydoc deprecation 25 26Stardoc is a replacement for the **deprecated** "Skydoc" documentation generator. 27 28See [Skydoc Deprecation](docs/skydoc_deprecation.md) for 29details on the deprecation and migration details. 30 31
){kind=link}