如何有条件地禁止在Sphinx文档索引中包含模块

时间:2014-09-24 21:15:00

标签: python python-sphinx documentation-generation

我有

   .. only:: some_build

      .. automodule:: some_module
         :members:
         :private-members:

在我的Sphinx RST文件中;但即使some_build为假或缺席,some_module也会出现在Sphinx生成的索引和模块列表中(即使按预期,也不会生成任何文档)。我似乎能够抑制此问题的唯一方法是使用:noindex:(但即使some_build为真,也会抑制所有索引和交叉引用)。

这是预期的行为吗?有没有办法有条件地索引用auto module记录的模块?

0 个答案:

没有答案