插入图像并保留成员的默认顺序



我想在Sphinx中使用某些方法后获得图像,我拥有的是:

Foo
============
.. autoclass:: Bar.foo
:exclude-members: baz
.. automethod:: baz
.. image:: ./images/baz_graph.png

问题是方法的顺序混淆了,方法baz现在是第一个出现在__init__之前的方法(默认顺序是bysource(。

我想要的是在一个方法之后插入一个图像,并使该方法和图像按bysource顺序排列。

没有办法像你想要的那样解决这个问题。在.. autoclass::指令中使用任何.. automethod::指令(为包含外部指令的成员声明的任何指令(会自动将该声明置于任何排序选项和成员:member:undoc-member:private-members:等的剩余自动排序选项之前

您必须以某种方式定义顺序,而:bysource:选项强制执行一个顺序;明确的指令声明强加了一个替代前者的附加命令。要对单个成员进行排序,您可以将前两种排序混合使用,但如果这两种排序不能像您希望的那样一起工作,则剩下的唯一可能的排序是.rst文件中每个成员的指令的有序声明。

当然,显式声明尽可能少的成员并让自动选项填充剩余的成员是很方便的。。。但是,如果您还想在每个成员下面包含一个映像,那么您唯一的选择就是用.. image::指令显式地声明内部指令。

相关内容

  • 没有找到相关文章

最新更新