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

How do I output a config value in a Sphinx .rst file?(如何在Sphinx.rst文件中输出配置值?)

本文介绍了如何在Sphinx.rst文件中输出配置值?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我在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!

这篇关于如何在Sphinx.rst文件中输出配置值?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本文标题为:如何在Sphinx.rst文件中输出配置值?

基础教程推荐