matplotlib / matplotlib/mpl-sphinx-theme
Sidebar template for non-core packages
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 6
- Fork
- 13
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
The top nav bar is hardcoded into the theme, which works well for matplotlib/matplotlib. However, for non-core packages there is no site-wide top level navigation. For matplotlib/pytest-mpl I've created a new sidebar template for the top level navigation: https://github.com/matplotlib/pytest-mpl/blob/main/docs/_templates/mpl_third_party_sidebar.html. This sidebar is set to appear above any existing "Section Navigation" sidebars on all pages. https://matplotlib.org/pytest-mpl/latest/index.html
Is this something that should be included in this theme so other non-core packages can have a consistent design? Or maybe you'd rather non-core packages just override the nav bar?
Hướng dẫn đóng góp
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.
Hướng nghiên cứu
Bắt đầu bằng cách so sánh điều hướng hiện có của theme với docs/_templates/mpl_third_party_sidebar.html và trang pytest-mpl đã render được liên kết trong issue. Xác nhận liệu theme có nên cung cấp sidebar này cho các package không thuộc core hay để việc đó cho các overrides; công việc được coi là hoàn tất khi hành vi điều hướng đã thống nhất được triển khai và ghi chép nhất quán.
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ính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 30/100