1*b2fa4294SXin Li# Stardoc - Starlark Documentation Generator 2*b2fa4294SXin Li 3*b2fa4294SXin Li[](https://buildkite.com/bazel/stardoc) 4*b2fa4294SXin Li 5*b2fa4294SXin LiStardoc is a documentation generator for [Bazel](https://bazel.build) build rules 6*b2fa4294SXin Liwritten in [Starlark](https://bazel.build/docs/skylark/index.html). 7*b2fa4294SXin Li 8*b2fa4294SXin LiStardoc provides a Starlark rule (`stardoc`, see [documentation](docs/stardoc_rule.md)) that can 9*b2fa4294SXin Libe used to build documentation for Starlark rules in Markdown. Stardoc generates one documentation 10*b2fa4294SXin Lipage per `.bzl`file. 11*b2fa4294SXin Li 12*b2fa4294SXin Li## Get Started 13*b2fa4294SXin Li 14*b2fa4294SXin Li* How to [set up Stardoc for your project](docs/getting_started_stardoc.md) 15*b2fa4294SXin Li* Writing [docstrings](docs/writing_stardoc.md) 16*b2fa4294SXin Li* How to [integrate Stardoc with your build](docs/generating_stardoc.md). 17*b2fa4294SXin Li* See also [Advanced Topics](docs/advanced_stardoc_usage.md). 18*b2fa4294SXin Li 19*b2fa4294SXin Li## About Stardoc 20*b2fa4294SXin Li 21*b2fa4294SXin Li* Stardoc [rule reference](docs/stardoc_rule.md). 22*b2fa4294SXin Li* How to [contribute to Stardoc](docs/contributing.md) 23*b2fa4294SXin Li 24*b2fa4294SXin Li## Project Status 25*b2fa4294SXin Li 26*b2fa4294SXin Li### Skydoc deprecation 27*b2fa4294SXin Li 28*b2fa4294SXin LiStardoc is a replacement for the **deprecated** "Skydoc" documentation generator. 29*b2fa4294SXin Li 30*b2fa4294SXin LiSee [Skydoc Deprecation](docs/skydoc_deprecation.md) for 31*b2fa4294SXin Lidetails on the deprecation and migration details. 32*b2fa4294SXin Li 33*b2fa4294SXin Li### Future plans 34*b2fa4294SXin Li 35*b2fa4294SXin LiSee our [future plans](docs/future_plans.md) for refactoring Stardoc to be more consistent with how Bazel evaluates .bzl files, and what it means for maintenance of this project. 36*b2fa4294SXin Li 37*b2fa4294SXin Li### Maintainer's guide 38*b2fa4294SXin Li 39*b2fa4294SXin LiSee the [maintaner's guide](docs/maintainers_guide.md) for instructions for 40*b2fa4294SXin Licutting a new release. 41*b2fa4294SXin Li 42
){kind=link}