如何在reStructuredText和Sphinx中命名或编号代码块？

Question

我会在reStructuredText中排队自动编号代码块，如果无法自动编号，则手动命名/编号。

.. code-block:: python
    :name: super awesome code exaple no 5
    a = 1

在训练中，我们可以参考它们并告诉学生我们现在正在做的女巫示例。我们不需要在文档本身中引用它们。

有可能吗？开箱即用还是扩展Sphinx？

Answer 1

可以通过扩展Sp​​hinx来实现。

您必须创建自己的扩展程序（请参阅how to create an extension和where to put your own extension），这将为您实施新的自定义指令（请参阅how to create a directive）。

指令是常见的Python类，因此NamedCodeBlock指令类应扩展CodeBlock指令类（请参阅sphinx.directives.code.CodeBlock）并添加对name可选参数的支持，您可以在其中为您设置名称代码块。