Vô hiệu hóa các thông báo cảnh báo Sphinx riêng lẻ

Question

Tôi có nhiều tệp .rst trong cây Sphinx của mình bị cố ý loại trừ khỏi bất kỳ cây chỉ mục nào. Tôi nhận được cảnh báo như

/filename.rst:: WARNING: document isn't included in any toctree 

Làm cách nào để ngăn chặn cảnh báo cụ thể trong Nhân sư?

Answer 1

1. Có tệp .rst trong dự án Sphinx của bạn có nội dung bạn không muốn ở đầu ra không?

   Sử dụng biến cấu hình exclude_patterns. Không có đầu ra (và không có thông báo cảnh báo) sẽ được tạo cho các tệp phù hợp với các mẫu được chỉ định. Xem http://sphinx-doc.org/config.html#confval-exclude_patterns.

2. Có tệp .rst nào trong dự án Sphinx của bạn không phải là một phần của bất kỳ toctree nào nhưng nội dung của chúng phải ở đầu ra?

   Thêm :orphan: ở đầu mỗi tệp .rst để chặn thông điệp cảnh báo. Xem http://sphinx-doc.org/markup/misc.html#file-wide-metadata.