在Sphinx中创建全局自定义角色

时间:2016-04-09 21:53:01

标签: python-sphinx

是否可以在Sphinx中创建全局自定义角色? (如果是这样,怎么样?)

我想在我的项目中创建一个可以像这样使用的角色:

Hello, this is :myrolename:`something` cool.

我可以像这样在sphinx rST文档中定义一个角色:

.. role:: myrolename

但是该角色仅在该定义之后和文件中定义。

或者,我可以创建一个包含内容的文件custom_roles.hrst:

.. role:: myrolename

然后我可以将它包含在我希望使用自定义角色的每个sphinx文件的顶部:

.. include:: custom_roles.hrst

这又近了一步,但是当我希望将整个项目全局包含在文件中时,手动“包含”文件仍然很烦人。

0 个答案:

没有答案