獅身人面像文檔變量

我寫文檔，使用一個新的項目Sphinx獅身人面像文檔變量

但由於該項目是新的，它的名字可能會改變，我不想取代的「項目名稱」所有參考我所有的文檔。

所以我想知道是否有一種方法可以在Sphinx上放置一些變量/常量來做到這一點。

我知道Sphinx上有一個i18n功能，所以我可以使用gettext來更改「項目名稱」，而不需要別的東西。但我正在尋找一種適當的方式來做到這一點。

來源

2013-02-28 Kakawait

使用配置值引用項目名稱sphinx。如果您使用sphinx-quickstart創建xyour sphinx項目，系統會詢問您的項目名稱。您可以通過改變project後來更改項目名稱的conf.py

您可以通過rst_epilog定義它們在conf.py使用您.rst文件配置值（見this answer爲例）。

來源

2013-03-01 08:51:52 bmu

因此，在實踐中將其放置在conf.py中：'rst_epilog ='.. | project_name |替換::％s'％project'。然後在你的.rst中，你可以簡單地在文本中的任何地方使用'| project_name |'。 – Pithikos 2016-05-22 14:28:00

從Sphinx documentation：

的reST支持「取代」（參考文獻），它們是文本和/或標記的片通過在文本稱爲|名稱|。它們被定義爲具有明確標記塊的腳註，如下所示： .. | name |替換::替換文本

或此： .. |警告| image :: warning.png ：alt：警告！

有關詳細信息，請參閱關於替換的參考。

如果你想使用一些替換的所有文件，把它們放進rst_prolog或者把它們放在一個單獨的文件並將其包含到你想使用它們中的所有文件，包括使用include指令。（一定要給予包括文件的文件擴展名從其它源文件不同，以避免獅身人面像發現它作爲一個獨立的文件。）

添加您的「項目變量」在rst_prolog和使用替代。

來源

2013-03-02 12:06:01 Sonson123

獅身人面像文檔變量

回答

相關問題