bazel-contrib / bazel-contrib/rules_python
sphinxdocs: allow repo rules to document their environment variables
- 主要语言
- Starlark
- 星标
- 688
- 派生
- 721
- 平均合并
- 15 小时 7 分钟
- 30 天内合并 PR
- 76
描述
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
贡献指南
调研方向
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.
由索引模型根据 Issue 内容生成。
评估
- 领域
- documentation
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100