狮身人面像内联包括

时间:2016-08-28 00:40:49

标签: python-sphinx restructuredtext

我想使用内联的sudo dnf install cppunit-dev 函数,但如果我将它与前一个文本中的两个新行分开,我只能实际包含我想要的文件。

在有人要求之前,我想要包含的文件是协议编号,所以不,它根本不会从新行中受益。我希望能够轻松地更改它,以便我可以在我的文档的多个位置使用它。我想一个例子就是"我们目前使用协议(proto.txt)。"我是Sphinx和rst的新手,所以也许我找不到一个非常明显的解决方案。

1 个答案:

答案 0 :(得分:3)

Sphinx无法使用内联包含。

但是,您可以在aliasesrst_epilog变量中定义全局 build configuration file

例如,您可以将以下行添加到conf.py文件中:

rst_epilog = """
  .. |version| replace:: 4.1
  .. |protocol| replace:: httpx
"""

现在,您可以从项目中的任何.rst文件中访问变量|version||protocol|,例如:

Version |version| uses the |protocol| protocol.

变为

Version 4.1 uses the httpx protocol.

如果软件的其他部分需要以特定文件或格式指定protocol(或其他变量),则可以编写脚本以将其作为变量读取到Sphinx配置文件中。 / p>