在我编写的一些斯芬克斯文档中,我包含了辅助文件中的代码示例,如下所示:
.. literalinclude:: mymodule.py
:pyobject: MyClass
:linenos:
这个特定的文档是一个教程,其中的类是逐步构建的。我要做的是包含整个类或单个方法,并且只强调该部分感兴趣的行。这样可以保留上下文,但有趣的部分一目了然。现在,我只提到了文本中的行号,这是可以的,但还远远不够理想。
查看斯芬克斯和侏儒的文档和代码,我找不到一个明显的方法来做到这一点。我并不反对修补它们,也不反对做一些棘手的事情,但我想知道是否有人解决了这个问题。
最佳答案
sphinx现在有一个emphasize-lines
指令用于文字包括:
http://sphinx-doc.org/markup/code.html#includes