在Sphinx中添加自定义标记

问题描述

我正在使用Sphinx工具进行文档编制，但遇到了一种情况，即我只想以一种文件格式公开一条信息。
我遇到了this link，它仅通过指令解决了类似的问题。

我面临的问题是我想使用带有自定义标记的唯一指令

.. only:: xyz

  ..directive ::
    :maxdepth: 1

    good_stuff

我使用setup.py文件进行构建，并运行BuildDoc.run(Self)来生成html文件。我想以某种方式在setup.py文件中传递这个定制标记。我尝试过这样做，但似乎无法从setup.py文件中访问标记对象。

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

如果我在conf.py文件中添加tag s.add(‘xyz’)，它将始终公开额外的信息，我想要做的是有条件地将该标记添加到我的setup.py文件中。
我假设make命令通过将标记信息传递给conf.py文件来执行类似的操作，但我不确定它是如何工作的。

---

解决方案

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')。