我想使用.. include::
函数内联,但只有当我用两行新行与前面的文本分开时,我才能让它实际包含我想要的文件。
在有人问之前,我想包含的文件是一个协议号,所以不,它根本不会从新行中受益。我希望能够轻松更改它,以便我可以在文档的多个位置使用它。我想一个例子是“我们当前使用协议(proto.txt)”。我是 Sphinx 的新手,所以也许我还没有找到一个非常明显的解决方案。
Sphinx 无法实现内联包含。
但是,您可以定义global aliases(替换)中rst_epilog
你的变量构建配置文件.
例如,您可以将以下行添加到您的conf.py
file:
rst_epilog = """
.. |version| replace:: 4.1
.. |protocol| replace:: httpx
"""
现在,您可以访问变量|version|
and |protocol|
来自项目中的任何 .rst 文件,例如如下所示:
Version |version| uses the |protocol| protocol.
becomes
Version 4.1 uses the httpx protocol.
如果您的软件的其他部分需要protocol
(或其他变量)以特定文件或格式指定,您可以编写一个脚本将其作为变量从那里读取到 Sphinx 配置文件中。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)