bazel-contrib / bazel-contrib/rules_python
sphinxdocs: allow repo rules to document their environment variables
- Ngôn ngữ chính
- Starlark
- Star
- 688
- Fork
- 721
- Merge trung bình
- 15 giờ 7 phút
- Pull request đã merge (30 ngày)
- 76
Mô tả
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
Hướng dẫn đóng góp
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Lĩnh vực
- documentation
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100