Python - 如何不按字母顺序对Sphinx输出进行排序

Question

使用Sphinx for Python,如何避免在HTML中按字母顺序排序所有方法/函数名称？我希望它们保持与源代码中的顺序相同.

Answer 1

从sphinx.ext.autodoc文档:

autodoc_member_order

此值选择自动记录的成员是按字母顺序排列(值'按字母顺序'),按成员类型(值'groupwise')还是按顺序排序(值'bysource').默认为按字母顺序排列.

请注意,对于源顺序,模块必须是包含可用源代码的Python模块.

所以在你的conf.py文件中的某处,放:

autodoc_member_order = 'bysource'

Answer 2

对于单个.rst文件（观察最后一个字符串）：

foo.bar module
=========================

.. automodule:: foo.bar
   :members:
   :undoc-members:
   :show-inheritance:
   :member-order: bysource