在Sphinx中添加自定義標籤

Question

我正在使用Sphinx工具進行文檔編輯，並遇到了一種情況，我只想以一種文件格式顯示一條信息。
我遇到了this link，它解決了類似的問題，只有指令的幫助。

的問題，我面對的，是我想使用的唯一指令與

.. only:: xyz 

    ..directive :: 
    :maxdepth: 1 

    good_stuff 

我使用了一個用於構建setup.py文件，並運行BuildDoc.run（個體經營）生成的自定義標籤html文件。我想以某種方式將這個自定義標籤傳遞給setup.py文件。我試過這樣做，但似乎我們不能從setup.py文件中訪問標籤對象。

def run(self): 
    self.builder = 'html' 
    *self.tags.add(xyz)* 
    BuildDoc.run(self) 
    self.zip("html.zip") 

如果我在conf.py文件中添加tags.add（「XYZ」），它總是會暴露更多的信息，我想要做的是有條件在我的setup.py文件添加此標記。
我假設make命令通過將標記信息傳遞給conf.py文件來做類似的事情，但我不確定它是如何工作的。

Answer 1

sphinx-build命令接受-t選項，該選項允許您指定一個標籤，然後您可以在only條件中使用該標籤。

從sphinx-build --help：

-t TAG   define tag: include "only" blocks with TAG 

因此，使用這樣的：

sphinx-build -t xyz 

將允許您使用.. only:: xyz條件直列。

---

在我看來，如果你想在你的setup.py文件有條件地應用標籤，你必須編寫自己的邏輯來確定是否應包括self.tags.add('xyz')與否。