Sphinx自动文档输出顺序

Question

3

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

特别是，我正在包含私有成员，使用:private-members:指令。我想要的是私有成员出现在输出的最后而不是默认情况下首先出现，这是由字母顺序和下划线“_”出现在“A”之前导致的。

- SomJura

阅读文档后，我发现了这个选项 https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_member_order 它是否符合您的要求？ - Steve Piercy

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- SuperKogito · Accepted Answer

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