首页 > 解决方案 > 访问 sphinx/重组文本中的源文件名

问题描述

我想将以下行添加到我的 Sphinx 文档的 conf.py 文件中,这显然对nbsphinx有效,但不适用于 Sphinx 4.0.2。

rst_epilog = r"""
{% set docname = env.doc2path(env.docname, base=None) %}

.. tip:: this is {{ docname }}
"""

更新

根据评论中的建议,我查看了这篇描述 Rst 和 Jinja 在 Sphinx 中的集成的博客文章,并尝试将本教程中有关创建自定义扩展的信息结合起来。

我的方法是按照教程包含目录和修改conf.py,同时将博客中的模块逐字用于我的扩展。

最终,我想要的用途仍然无法正常运行。make我可以通过在模块中包含拼写错误(这会导致失败)或将扩展更改为什么都不做(即注释掉rstjinja函数的最后一行,因此扩展除了消耗 CPU 周期之外什么都不做)来确认 Sphinx 知道我的扩展.

标签: python-sphinxrestructuredtext

解决方案


推荐阅读