Sphinx / rST：在include语句中使用配置值？

Question

在我的主要sphinx项目中，我使用include语句来提取存储在磁盘上其他位置的文件内容。

.. include:: //path/to/other/docs/file.rst

现在我希望能够在我的conf.py中设置一次基本路径，并在我的include语句中引用它。

这是否可行，如果可行，我该如何实现？

---

供将来参考：我写了一个允许这个的Sphinx扩展，请参阅： https://github.com/j0nes2k/sphinx-contrib-configurableinclude

Answer 1

你无法用香草狮身人面像做到这一点。 include指令的实现似乎并不关心任何其他配置选项：

• sphinx.directives.other.Include.run()
• sphinx.environment.BuildEnvironment.relfn2path()

但是您可以实现并设置自己的指令。查看Writing a simple extension的Developing extensions for Sphinx部分。

所以最简单的方法似乎会覆盖sphinx.directives.other.Include。 （实际上，Sphinx的Include也覆盖了标准包含指令docutils.parsers.rst.directives.misc.Include，以便更好，更正确地进行路径解释。）