xref: /aosp_15_r20/external/bazel-skylib/gazelle/bzl/README.md (revision bcb5dc7965af6ee42bf2f21341a2ec00233a8c8a)
1# Gazelle
2
3Gazelle is a `BUILD` file generator for Bazel. This directory contains a
4language extension for the Gazelle generator that allows it to automatically
5parse valid `bzl_library` targets for all `.bzl` files in a repo in which it
6runs. It will additionally include a `deps` entry tracking every `.bzl` that is
7`load`ed into the primary file.
8
9This can be used, for example, to generate
10[`stardoc`](https://github.com/bazelbuild/stardoc) documentation for your
11`.bzl` files, both simplify the task of and improve the quality of
12documentation.
13
14