如何在狮身人面像中创建全球角色/角色？

Question

这是“其余的删除线” ReST strikethrough但在狮身人面像，而不是休息上下文随访。我的问题是是否有狮身人面像中央地方放一个“角色”指令还是该指令真的有在每一个RST文件中重复狮身人面像docmentation内。

的详细信息：

这是很容易定义嵌入式文本自定义CSS样式（见其余的删除线为例）使用的角色指令：

.. role:: custom 
    :class: custom 

This is an :custom:`inline text`. 

它转换成

一个HTML呈现

.. This is an <span class="custom">inline text</span>. .. 

此外，自定义样式表可以很容易地加入到狮身人面像（见http://www.tinkerer.me/doc/theming.html），其中添加CSS类选择，以控制“定制”文本呈现（颜色，删除线，字体，大小......）

什么disturbes我是在我的实验，我不得不重复的角色指令中所使用的自定义角色的每个其余文件。有一个“中央”的地方，我可以为整个网站定义一次吗？

Answer 1

看起来rst_prolog设置在conf.py文件是我正在寻找的中心位置。 Rst_prolog是“一个reStructuredText字符串，它将包含在每个读取的源文件的开头”。就我而言，我只是简单地添加以下到conf.py：

rst_prolog = """ 
.. role:: test2 
""" 

另请注意，我的目的，作用指令无类attibute工作得很好。

显然，正如克里斯指出的，通过包含一个global.rst文件，可以实现完成许多事情的rst_prolog。 [但是，它的相对路径可能存在问题。也许最好使用rst_prolog =开放（ 'global.rst'， 'R'）阅读（）--untested]

Answer 2

从例如在documenting your project using sphinx，您可以使用include代替一个global.rst文件，其中包含所有角色的指令，到你的其他文件。从这个网站：

语法：

.. include:: myfile.rst 

志 “内联” 给定文件（myfile.rst）。 我用的是建立一个全球.rst文件常见的做法称为global.rst，并包括在每一个页面的顶部。非常有用的链接到常见的图像或常见的文件链接等