2013-04-28 24 views
7

Tôi đang cố sử dụng của để đưa tài liệu từ một tệp vào một tệp khác, để tránh sao chép văn bản nguồn của tài liệu. Phần tôi bao gồm là trong configuration.rst (nó là một phần của các tài liệu tham khảo cho các thiết lập cấu hình) và nó có chứa một số nhãn cho tham khảo chéo mỗi thiết lập cấu hình:Nhân sư .. bao gồm cảnh báo :: chỉ thị và "trùng lặp nhãn"

.. start_config-authorization 

.. _ckan.auth.anon_create_dataset: 

ckan.auth.anon_create_dataset 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 

Example:: 

ckan.auth.anon_create_dataset = False 

Default value: ``False`` 

Allow users to create datasets without registering and logging in. 


.. _ckan.auth.create_unowned_dataset: 

ckan.auth.create_unowned_dataset 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 

... 

.. end_config-authorization 

Trong tập tin khác (authorization.rst) tôi bao gồm chỉ các thiết lập cho phép cấu hình từ configuration.rst nội tuyến, như thế này:

.. include:: /configuration.rst 
    :start-after: start_config-authorization 
    :end-before: end_config-authorization 

vấn đề là các nhãn trong văn bản bao gồm sản xuất cảnh báo này từ Sphinx:

doc/configuration.rst:224: WARNING: duplicate label ckan.auth.anon_create_dataset, other instance in doc/authorization.rst 

Cho đến nay tham khảo chéo dường như không thể bị phá vỡ, nếu tôi đặt:

:ref:`ckan.auth.anon_create_dataset` 

trong một tập tin thứ ba, điều này tạo ra một cách chính xác một liên kết đến định nghĩa của ckan.auth.anon_create_dataset trong configuration.html (và không phải là bản sao bao gồm của nó trong authorization.html).

Có an toàn để chỉ đơn giản là bỏ qua hoặc tắt tiếng các cảnh báo nhãn trùng lặp này và mong đợi tất cả các liên kết chéo liên kết đến configuration.html? Hay tôi nên tìm cách khác để làm điều này?

Trả lời

0

An toàn để bỏ qua? Nó sẽ vẫn là một cảnh báo nhưng nội dung ban đầu dường như chặn các nhãn bao gồm vì vậy nó không nên quá nguy hiểm nếu bạn kiểm tra nó theo thời gian.

Bạn đã thử đưa nội dung vào một tệp, không được lập chỉ mục không có nhãn, bao gồm tệp này ở bất cứ đâu bạn cần và tạo tệp, lập chỉ mục, có nhãn và bao gồm nội dung không được gắn nhãn không? Tệp cuối cùng phải được chỉ dẫn bởi tham chiếu.

Ps: Tôi chưa thử nghiệm để nhãn có thể bị gạch ngang bởi thực tế nó được theo sau bởi nội dung bao gồm và không phải tiêu chuẩn.

+0

Không thực sự. Tôi nghĩ rằng nếu một bản sao được phát hiện, nó sẽ bị bỏ qua. Tham chiếu sẽ không có liên kết hoặc mục tiêu sẽ không được tạo hoặc cả hai. – erikbwork

3

Có hai cách để giải quyết vấn đề này: chuyển sang tiện ích khác (* .inc) hoặc thêm bất kỳ tệp nào vào exclude_patterns trong conf.py.

Các vấn đề liên quan