Public docs_bundle is not self-contained because bundle examples include files outside docs/
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 55/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Lĩnh vực
- build-system, documentation
Hướng nghiên cứu
Bắt đầu với docs/how-to/bundles/examples.rst và định nghĩa public //:docs_bundle, sau đó tái hiện lỗi với cấu hình external-bundle và bazel run //:docs. Truy vết những tệp ví dụ nào được xuất ra bên ngoài docs/. Hoàn tất khi cả các bản build standalone và external-bundle đều thành công mà không có lỗi path-confinement.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Problem
The public //:docs_bundle includes docs/how-to/bundles/examples.rst and the nested bundle example mounts. That page uses literalinclude paths such as:
../../../src/tests/docs_bzl/scenarios/nested_bundles/BUILD
../../../src/tests/docs_bzl/scenarios/data_files_runfiles/BUILD
../../../src/tests/docs_bzl/scenarios/external_bundle/BUILD
These files are outside the docs/ source directory. The documentation builds successfully as the standalone docs-as-code project, but fails when its docs_bundle is consumed by another Sphinx project because sphinx-mounts enforces path confinement for mounted documents.
Reproduction
Consume @score_docs_as_code//:docs_bundle from eclipse-score/reference_integration with score_docs_as_code 8.1.0:
{
"bundle": "@score_docs_as_code//:docs_bundle",
"mount_at": "process_methods_tools/docs_as_code",
"attach_to": "process_methods_tools",
}
Run:
bazel run //:docs
Observed result:
sphinx-mounts: mounted doc process_methods_tools/docs_as_code/how-to/bundles/examples references a file outside its bundle root: .../score_docs_as_code+/src/tests/docs_bzl/scenarios/nested_bundles/BUILD is not under .../score_docs_as_code+/docs
A previous closed PR, #514, attempted to add support for literalinclude outside docs/; this is the same class of problem now exposed through the public external bundle and should be resolved either by packaging the included files into the bundle or by excluding these test-fixture examples from the exported bundle.
Expected behavior
The public docs_bundle should be self-contained and mountable by another Sphinx project without path-confinement errors. The standalone documentation build and the external-bundle build should exercise the same contract.
- Ngôn ngữ chính
- Python
- Star
- 11
- Fork
- 33
- Merge trung bình
- 22 giờ 43 phút
- Pull request đã merge (30 ngày)
- 65
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của eclipse-score/docs-as-code
-
good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
eclipse-score/docs-as-code#850 ·
-
make _build folder configurable Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
eclipse-score/docs-as-code#771 · 1 người được giao ·
-
Add project name to headline ... Đang mởdocumentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
eclipse-score/docs-as-code#613 · 1 bình luận ·
-
update py_venv Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
eclipse-score/docs-as-code#606 ·
-
bug waiting_for_author
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
eclipse-score/docs-as-code#288 · 2 bình luận ·
Tất cả issue của eclipse-score/docs-as-code
Issue tương tự
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
stephrobert/dsoxlab#238 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
sublimehq/package_control#1780 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
nwg-piotr/nwg-displays#145 ·