如何在獅身人面像中創建全球角色/角色？

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，幷包括在每一個頁面的頂部。非常有用的鏈接到常見的圖像或常見的文件鏈接等