bazel-contrib / bazel-contrib/rules_python

doc: document current_cc_headers and related targets

未关闭
#3,098 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
cleanup type: documentation
主要语言
Starlark
星标
688
派生
721
平均合并
15 小时 7 分钟
30 天内合并 PR
76

描述

This is a ticket to document the targets in https://github.com/bazel-contrib/rules_python/blob/cab415d82ebbfd1b8b2d81ef61baf3f9a274a1b2/python/cc/BUILD.bazel#L15 and other in the same file so that we can point users to documentation on how to use toolchain lookup instead of the legacy alias targets in toolchain repos that we are still creating.

Maybe this ticket can also document similar targets for the python toolchain as well.

EDIT: Looked at the docs again and I see that the easiest way to document this would be to add a sentence or two in https://rules-python.readthedocs.io/en/latest/toolchains.html#python-c-toolchain-type so that the users know how to consume headers and `libpython`.

Cross-referencing https://rules-python.readthedocs.io/en/latest/toolchains.html#local-toolchain with `seealso` to the `python-c-toolchain-type` would be also useful.

贡献指南

打开贡献指南

调研方向

阅读 python/cc/BUILD.bazel 中的 targets,然后查看 toolchains.html 的“python-c-toolchain-type”和“local-toolchain”部分。记录用户如何通过 toolchain 查找来使用 headers 和 libpython,并添加建议的 seealso 交叉引用;明确是否也应涵盖类似的 Python toolchain targets。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
build-system, documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
55/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。