bazelbuild / stardoc

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

Enable generating a table of contents in Stardoc #203

Closed ahumesky closed 2 months ago

ahumesky commented 3 months ago

Adds a bool generate_table_of_contents to stardoc() to enable table of contents. This defaults to False for backwards compatibility. Adds a Label table_of_contents_template to stardoc() to specify the vm template.

The default table of contents template looks like this (from the test):

Rules

Providers

Functions

Aspects

Repository Rules

Module Extensions

ahumesky commented 3 months ago

The presubmit wants me to run buildifier on stardoc/private/stardoc.bzl but this results in a large diff of unrelated changes -- should we ignore this, accept the large unrelated diff, or run buildifier on the whole repo and then sync this?