Sphinx Autodoc输出顺序

时间:2019-03-22 16:54:04

标签: python-sphinx private-members autodoc

是否可以更改Sphinx AutoDoc生成的输出的顺序?

尤其是,我使用:private-members:指令包括私有成员。 我想要的是私有成员出现在输出中 last ,而不是出现在默认值中的first,这是由字母顺序和“ _”字符出现在“ A”之前引起的。

1 个答案:

答案 0 :(得分:0)

就像@Steve Piercy提到的那样,您可以使用配置值autodoc_member_order设置顺序。要获得所需的行为,只需将autodoc_member_order = 'bysource'添加到您的conf.py中即可。这将使您的文档订单与源订单相同。