bazel-contrib / bazel-contrib/rules_python

sphinxdocs: allow repo rules to document their environment variables

Aperta
#3,299 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
sphinxdocs type: feature request
Lingua principale
Starlark
Stelle
688
Fork
721
Merge medio
15h 7m
PR unite (30g)
76

Descrizione

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:
:::

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

Description of how its used.
:::
```

In all cases, it xrefs to `.. envvar` directives

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.