python - Sphinx 文档变量

Question

我正在使用 Sphinx 为一个新项目编写文档

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

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

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

Answer 1

项目名称由 sphinx 使用配置值引用。如果您使用 sphinx-quickstart 创建 xyour sphinx 项目，系统会询问您的项目名称。 之后您可以通过更改 conf.py

中的 project 来更改项目名称

您可以在 .rst 文件中使用配置值，方法是在 conf.py 中使用 rst_epilog 定义它们(参见 this answer 了解例子)。