bazel-contrib / bazel-contrib/rules_python
sphinxdocs: allow repo rules to document their environment variables
- Langage dominant
- Starlark
- Étoiles
- 688
- Forks
- 721
- Merge moyen
- 15 h 7 min
- PR mergées (30 j)
- 76
Description
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
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Start by tracing the existing `repo-rule`, `envvar`, and docgen directives in the Sphinx documentation system. Determine where directive options and cross-references are implemented, then verify that repository rule documentation can list environment variables and that each `uses-envvar` entry links to the corresponding `envvar` directive.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Domaine
- documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100