bazel-contrib / bazel-contrib/rules_python

doc: howto configure bazel downloader with pip.parse

Đang mở
#3,102 4 bình luận 1 reaction 0 người được giao Xem trên GitHub
type: documentation
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ả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu bằng việc xem xét tài liệu PyPI hiện có và các tham chiếu đến pip.parse và compile_pip_requirements. Thêm một ví dụ how-to cho thấy cách Bazel downloader chuyển hướng các yêu cầu URL của wheel, và sắp xếp ví dụ đó trong một khu vực tài liệu how-to riêng nếu phù hợp; được xem là hoàn tất khi cấu hình được ghi lại rõ ràng cho người dùng tùy chỉnh vị trí tải xuống.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
Nửa 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

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.