如何从我的.rst文件中访问sphinx conf.py中的变量?

时间:2015-11-30 19:51:28

标签: python python-sphinx restructuredtext

我是Sphinx和reStructuredText的新手。

在我的狮身人面像内conf.py我定义了:

version = '0.0.2'

tutorial.rst内部我想访问version变量并在我的html文件中显示0.0.2。我试过了:

version

|version|

:version:

.. |version|

.. :version:

我成功测试了该版本的内容。

.. ifconfig:: version == '0.0.2'

    This prints!

这很令人鼓舞,但不是我想要的。

1 个答案:

答案 0 :(得分:7)

如果您希望随处可用,可以执行以下操作:

<强> conf.py

rst_epilog = """
.. |ProjectVersion| replace:: Foo Project, version {versionnum}
""".format(
versionnum = version,
)

<强> file.rst

As one may see, we have made significant strides in |ProjectVersion| 
and hope that you enjoy the product!

rst_epilog 列表使其中的项全局可用于已编译的.rst文件。见http://www.sphinx-doc.org/en/1.4.8/config.html#confval-rst_epilog