如何在Sphinx.rst文件中输出配置值?

2022-04-20 00:00:00 python python-sphinx

问题描述

我在conf.py中有以下内容:

def setup(app):
    app.add_config_value('base_url','http://localhost:2000', True)
如何将其添加到我的.rst文件中?我是这样写的:

:base_url:/my_app/api/application/
但它只打印:base_url:,而不是实际的URL。

如何获取要发出的实际配置值?


解决方案

用于替换链接extlink可以包括您问题中提出的任意配置值,您可以使用rst_epilog进行替换(或者rst_prolog对于文本,应将其添加到.rst文件的顶部):

在您的配置文件.py中:

my_config_value = 42
rst_epilog = '.. |my_conf_val| replace:: %d' % my_config_value

在您的.rst源中:

我的配置值为|my_conf_val|!

在您的输出中:

我的配置值是42!

相关文章