斯芬克斯的..包括::指令和「重複標籤」警告

我試圖用Sphinx的.. include:: directive將文件從一個文件包含在另一個文件中，以避免重複文檔的源文本。我包括的部分是configuration.rst（它的參考文檔的配置設置的一部分），它包含了交叉引用的每個配置設置一些標籤：斯芬克斯的..包括::指令和「重複標籤」警告

.. 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

在另一個文件（authorization.rst）我只包括從configuration.rst在線授權的配置設置，如：

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

的問題是，所包含的文本中的標籤生產從獅身人面像這樣的警告：

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

到目前爲止交叉引用似乎並沒有被打破，如果我把：

:ref:`ckan.auth.anon_create_dataset`

在第三個文件，這會產生正確的configuration.html（而不是包含副本的鏈接到的ckan.auth.anon_create_dataset定義它在authorization.html）。

簡單地忽略或沉默這些重複標籤警告是否安全？並且期望所有交叉引用鏈接到configuration.html？或者我應該找到另一種方式來做到這一點？

來源

2013-04-28 Sean Hammond

安全可以忽略？它仍然是一個警告，但原來的內容似乎阻止了包含的標籤，所以它不應該太危險，如果你不時檢查它。

您是否嘗試將文件中的內容放入文件中，而不是使用無標籤進行索引，在需要的地方包含此文件，並使用標籤創建索引文件幷包含未標記的內容？最後一個文件應該由引用指出。

Ps：我還沒有測試過，所以標籤可能會被其後面是包含而非標準內容的事實超越。

來源

2013-04-28 13:10:13 martinqt

不是。我認爲如果檢測到重複，它將被忽略。要麼引用沒有鏈接，要麼目標不會被創建，或者兩者都不會。 – erikbwork 2013-09-26 09:34:10

解決此問題的方法有兩種：切換到不同的擴展名（* .inc），或將任何包含文件添加到exclude_patterns中的conf.py。

來源

2016-02-21 20:41:37 jhermann

斯芬克斯的..包括::指令和「重複標籤」警告

回答

相關問題