bazel-contrib / bazel-contrib/rules_python
sphinxdocs: allow repo rules to document their environment variables
- Lenguaje dominante
- Starlark
- Estrellas
- 688
- Forks
- 721
- Merge medio
- 15 h 7 min
- PR fusionados (30 d)
- 76
Descripción
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
Guía de contribución
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100