Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.58 KB

mine.rst

File metadata and controls

34 lines (21 loc) · 1.58 KB

替代(Substitutions)

reST语言支持"替代"( 参考),即使用 |替代名称| 的格式定义的文本和(或)标记对象,类似脚注,使用显式标记文本块定义,例如:

.. |替代名称| replace:: replacement *实际名称*

或者:

.. |替代名称| image:: 图片路径.png
     :alt: 图片提示信息

详细内容参见 reST替代参考

如果想为所有文档使用固定替换,可将所有替代放入 rst_prologrst_epilog 或放入独立文件,并在所有需要的文件里使用 include 指令添加进来。(确保添加的文件扩展名与其他文档不同,以免Sphinx将其识别为单独的文档。)

注释(Comments)

定义没有标记文本结构的显式标记文本块为注释( 参考)。例如:

.. "Miracles, magic... They are real!" ― Puella Magi Madoka☆Magica

也可以通过在注释后一行缩进文本,组织多行注释:

.. "Don't forget.
Always, somewhere,
someone is fighting for you.

--As long as you remember her,
you are not alone." - ending sequence.

其他问题