Add the sphinx-codeautolink extension to the doc build process?
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 77.2k
- Fork
- 35.9k
- Chỉ số merge pull request
- Chỉ số pull request đang chờ
Mô tả
I am proposing to include the https://github.com/felix-hilden/sphinx-codeautolink Sphinx extension into the documentation build process. This extension makes parseable Python code examples clickable so that it's easy to jump to the reference documentation of an object.
Related thread: https://discuss.python.org/t/add-the-sphinx-codeautolink-extension-to-doc-build-process/80814/11
A pull request to add the extension is upcoming.
Linked PRs
- gh-134896
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 xem xét cấu hình build tài liệu và dự án sphinx-codeautolink được liên kết trong issue, sau đó đọc thread liên quan trên discuss.python.org và PR gh-134896. Công việc được xem là hoàn tất khi extension được đưa vào build tài liệu và các ví dụ Python có thể phân tích được trở thành các liên kết có thể nhấp đến tài liệu tham chiếu.
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ó
- 3/5
- Thời gian dự kiến
- 1-2 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
- 25/100