4. Sphinx中的角色与指令#
与其他工具相比,Sphinx 使用的 RestructuredText 允许更高程度的自定义。 在Sphinx中称为 角色(role)与指令(directive)。
指令是通用块的显式标记。虽然Docutils提供了许多指令,但Sphinx提供了更多的指令,并将指令用作主要的扩展机制之一。
在 Sphinx 中有些角色与指令需要(甚至必须)配合使用才能实现完整功能。 这些功能涉及到交叉引用、脚注、引文等。
与其他工具相比,Sphinx 使用的 RestructuredText 允许更高程度的自定义。 在Sphinx中称为 角色(role)与指令(directive)。
指令是通用块的显式标记。虽然Docutils提供了许多指令,但Sphinx提供了更多的指令,并将指令用作主要的扩展机制之一。
在 Sphinx 中有些角色与指令需要(甚至必须)配合使用才能实现完整功能。 这些功能涉及到交叉引用、脚注、引文等。