eclipse-score / eclipse-score/docs-as-code
Sphinx config should not have pathlib instances
- Ngôn ngữ chính
- Python
- Star
- 10
- Fork
- 32
- Merge trung bình
- 23 giờ 52 phút
- Pull request đã merge (30 ngày)
- 52
Mô tả
During the implementation of https://github.com/eclipse-score/docs-as-code/pull/283 I observed that pathlib instances are created in the Sphinx configuration.
Affected path `needs.external_needs[0].json_path`.
Those can not be reflected in a declarative configuration such as TOML.
Paths should be stored as strings to be loadable from external TOML files.
It also makes sense for configuration pickling that Sphinx does for incremental builds.
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
Hướng nghiên cứu
Theo dõi việc xử lý cấu hình Sphinx cho needs.external_needs[0].json_path, bao gồm cả phần triển khai được thảo luận trong pull request 283. Xác minh cách giá trị được tạo và tải, sau đó xác nhận rằng các giá trị cấu hình vẫn là chuỗi và có thể được biểu diễn trong TOML bên ngoài cũng như bằng pickling cho các bản build gia tă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, tooling
- Loại issue
- Lỗi
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Sôi nổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 70/100