rules_python icon indicating copy to clipboard operation
rules_python copied to clipboard

sphinxdocs: allow repo rules to document their environment variables

Open rickeylev opened this issue 3 months ago • 0 comments

Starting with Bazel 7.1, repository rules can use repository_ctx.getenv() to get environment variable values, and they no longer have to be listed in the environ attribute of the repo rule.

This makes them hidden from docgen.

A directive or option should be added so that repo rule docs can describe what environment variables they use.

:::{repo-rule}
:uses-envvars: <csv list of names>
:::

:::{uses-envvar} env-var-name

Description of how its used.
:::

In all cases, it xrefs to .. envvar directives

rickeylev avatar Sep 28 '25 01:09 rickeylev