2013-01-24 12 views
11

Khi xây dựng tài liệu html, làm thế nào để bạn buộc nhân sư báo cáo hoặc tạo lỗi, trên các liên kết không tồn tại?có liên kết bị hỏng báo cáo nhân sư

Cụ thể, tôi có các thuộc tính và phương thức trong dự án Python đã bị xóa hoặc đổi tên, và khó tìm ra tất cả các liên kết chết với đầu ra html được tạo ra bằng nhân sư.

Tôi cảm thấy mình đang nhìn chằm chằm vào câu trả lời ở đây: http://sphinx-doc.org/glossary.html, như được mô tả trong đoạn mở đầu.

Tôi rõ ràng không hiểu điều gì đó.

Trả lời

4

Tôi nghĩ rằng CheckExternalLinksBuilder là những gì bạn đang tìm kiếm.

Nó về cơ bản được sử dụng bằng cách gọi 'nhân sư xây dựng' với tùy chọn -b linkcheck. Vui lòng xem sphinx-build để biết thêm thông tin. Ngoài ra, hãy xem danh sách các phần mở rộng nhân sư herehere.

+2

Điều đó không có tác dụng trong việc tìm kiếm các thuộc tính và phương thức trong dự án Python của tôi đã bị xóa hoặc đổi tên. Dường như chỉ hoạt động với các liên kết bên ngoài. – Idaho

+0

Ok, tôi hiểu rồi. Tôi không chắc rằng việc tìm kiếm các đặc tính hoặc phương pháp bị hỏng là công việc cho Nhân sư. Âm thanh như pylint, pyflakes là công cụ thích hợp cho công việc. – alecxe

12

Đặt biến cấu hình nitpicky thành True (bạn cũng có thể sử dụng -n option khi chạy nhân sư xây dựng).

Ở chế độ nitpicky, tham chiếu chéo tới một hàm (chẳng hạn như :func:`myfunc`), lớp hoặc đối tượng khác không thể tìm thấy sẽ tạo ra một thông báo cảnh báo.

+0

tuyệt vời, thêm "nitpicky = True" vào tệp conf.py của dự án đã sửa nó. – Idaho

+2

câu trả lời rất hay! có cách nào để chuyển hướng những cảnh báo đó tới một tệp không? – jsmedmar

+1

@jsmedmar, bạn đã thử sử dụng tùy chọn [** - w **] (http://www.sphinx-doc.org/en/stable/invocation.html#cmdoption-sphinx-build-w) chưa? – mzjn