狮身人面像的扩展,允许替换。
Sphinx-Substitution-Extensions的Python项目详细描述
Sphinx Substitution Extensions
狮身人面像的扩展,允许替换。
内容
Installation
$ pip install Sphinx-Substitution-Extensions
这支持Python3.5+。
Setup
- 将以下内容添加到conf.py:
extensions+=['sphinx-prompt','sphinx_substitution_extensions']
- 在conf.py中设置以下变量:
substitutions=[('|release|','0.1'),('|author|','Eleanor'),]
这将用0.1替换新指令中的|release|,用Eleanor替换|author|。
Directives
^{tt1}$
..substitution-code-block:: bash echo "|author| released version |release|"
这是sphinx内置code-block指令的扩展,并添加了替换功能。
^{tt2}$
..substitution-prompt:: bash echo "|author| released version |release|"
这是sphinx-prompt的扩展。
substitution-prompt的行为类似于sphinx-prompt,并添加了替换功能。
Credits
ClusterHQ Developers
这个包的灵感主要来自clusterhq为flocker编写的代码。 相关代码的开发人员至少包括jon giddy和tom prince。