python-sphinx - Sphinx Autodoc 输出顺序

Question

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

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

标签： python-sphinxprivate-membersautodoc

Answer 1

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