在建立文件时,如何告诉Sphinx忽略'include'指令?

时间:2019-05-27 11:48:32

标签: python-sphinx

我从命令行运行sphinx-build命令来构建乳胶和html文档,因为它们具有相同的.rst源文件:

$ sphinx-build -b html <source> <output>

$ sphinx-build -b latex <source> <output>

但是,对于乳胶输出,我想忽略所有的“ include”指令。

这可以通过在与sphinx的conf.py相同的目录中添加docutils.conf文件来完成,其内容如下:

[parsers]
[restructuredtext parser]
file-insertion-enabled:false

这是部分解决方案,因为每次我为html和乳胶输出运行sphinx-build时,都必须更改docutils.conf文件的内容(错误或正确)。

是否可以告诉sphinx忽略'include'指令而无需依赖docutils.conf文件,该文件指定运行no-file-insertion命令时要sphinx-build吗?

1 个答案:

答案 0 :(得分:0)

经过一段时间的搜索,我发现了一个狮身人面像指令,仅当表达式为真时才包含其内容(only指令):

.. only:: html

    .. include:: <path/to/file.rst>

这是一个简单的解决方案,对我来说很好用; file.rst的内容仅在制作html文档时包括,而在制作乳胶文件时不包括。

谢谢!