Sphinx docs变量

Question

我正在使用Sphinx

编写新项目的文档

但是因为这个项目是新的，它的名字可能会改变，我不想在我的所有文档中替换所有“项目名称”的引用。

所以我想知道是否有办法在Sphinx上设置一些变量/常量来做到这一点。

我知道i18n上有一个Sphinx功能，所以我可以使用gettext来更改“项目名称”而不需要其他功能。但我正在寻找一种合适的方法来做到这一点。

Answer 1

项目名称由sphinx使用配置值引用。系统会询问您是否使用sphinx-quickstart创建xyour sphinx项目的项目名称。 您可以通过更改project

中的conf.py来更改项目名称

您可以在.rst文件中使用conf.py文件中的配置值，并rst_epilog使用{{1}}（例如，请参阅this answer）。

Answer 2

来自Sphinx documentation：

  

reST支持“替换”（ref），它们是文本中引用的文本和/或标记| name |。它们被定义为带有显式标记块的脚注，如下所示：   .. |名字| replace :: replacement text

     

或者：   .. |谨慎| image :: warning.png                ：alt：警告！

     

有关详细信息，请参阅reST参考文章。

     

如果要对所有文档使用替换，请将它们放入rst_prolog或将它们放入单独的文件中，并使用include指令将其包含在要使用它们的所有文档中。 （确保为包含文件提供与其他源文件不同的文件扩展名，以避免Sphinx将其作为独立文档发现。）

在rst_prolog中添加“项目变量”并使用替换。