bazel-contrib / bazel-contrib/rules_python

doc: howto configure bazel downloader with pip.parse

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

描述

I think I've seen this question a few times: I want to customize where wheels are downloaded from. What parameters do I set in (pip.parse or compile_pip_requirements) to do that?

When the answer is non-obvious: use bazel downloader to redirect the url requests.

This is mentioned in the regular pypi docs, but only briefly; it's easy to overlook.

We should give an example in the docs on how to do this.

A dedicated "how to" sub-directory of docs is probably a good idea. It'll be a good place to put prose documentation that draws people in, and we can easily expand it with arbitrary topics and content without it feeling out of place or bloating the more dry/technical/reference docs.

贡献指南

打开贡献指南

调研方向

首先查看现有的 PyPI 文档以及对 pip.parse 和 compile_pip_requirements 的引用。添加一个 how-to 示例,展示 Bazel downloader 如何重定向 wheel URL 请求,并在适当的情况下将其整理到专门的 how-to 文档区域中;当面向自定义下载位置的用户清楚地记录了该配置时,即表示完成。

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

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
半天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

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