bazelbuild / stardoc

Stardoc: Starlark Documentation Generator
Apache License 2.0
103 stars 40 forks source link

Docstrings for top-level constant values (strings, lists, dicts, structs) #202

Open tetromino opened 3 months ago

tetromino commented 3 months ago

We generate API docs for bazel build language objects which include a doc field (such as rules, providers, and aspects) or have a docstring set by convention (modules, functions); but we do not document any other Starlark values such as strings, lists, tuples, dicts, or structs.

However, .bzl files frequently define string/list/etc. constants as part of their API, and documenting them would seem a good idea.

Prior art in Python land: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-autoattribute

aaronsky commented 1 month ago

did a little bit of research for this just now. not super familiar with the code, but i don't see anything in the proto that would give us this information. so maybe this requires changes to bazel first?

tetromino commented 1 month ago

@aaronsky - yes.