Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Sphinx documentation: No backlink to the main project

Đang mở Phù hợp với người mới
#258 0 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Kiểm tra cấu hình tài liệu Sphinx cho Python bindings, đặc biệt là thiết lập thanh bên, và xem xét bố cục trang được tạo. Công việc hoàn tất khi tài liệu bao gồm một backlink đến https://precice.org/couple-your-code-api.html và liên kết này hiển thị trong thanh bên hoặc phần điều hướng tương đương.

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

Mô tả

documentation

In the Sphinx documentation, there is no backlink to the preCICE website. That would be useful for people landing directly to the Python bindings documentation from a search engine, for example.

I think that adding something in the sidebar, for example, would be good. It could link to https://precice.org/couple-your-code-api.html

Current view:

Image

Diverged from #239

Ngôn ngữ chính
Cython
Star
30
Fork
19
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của precice/python-bindings

Tất cả issue của precice/python-bindings

Issue tương tự

Thêm issue về Documentation

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.