bazel-contrib / bazel-contrib/rules_python
sphinxdocs: allow repo rules to document their environment variables
- 主要言語
- Starlark
- スター
- 688
- フォーク
- 721
- 平均マージ
- 15時間 7分
- マージ済み PR(30日)
- 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