Sphinx Autodoc 输出顺序

Question

是否可以更改使用 Sphinx AutoDoc 生成的输出的顺序？

特别是，我使用 :private-members: 指令包括私有成员。 我想要的是私有成员在输出中出现 last 而不是第一个，这是默认的，这是由字母顺序和 "A" 之前的“_”字符引起的。 =11=]

Answer 1

正如@Steve Piercy 提到的，您可以使用配置值 autodoc_member_order 来设置顺序。要获得所需的行为，只需将 autodoc_member_order = 'bysource' 添加到您的 conf.py。这将使您的文档顺序与源代码顺序相同。