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

Question

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

Answer 1

来自sphinx.ext.autodoc documentation：

  

<强> autodoc_member_order

     

此值选择自动记录的成员是按字母顺序排列（值＆＃39;按字母排序＆＃39;），按成员类型（值＆＃39;分组＆＃39;）还是按来源顺序排序（值＆＃39; bysource＆ ＃39）。默认为按字母顺序排列。

     

请注意，对于源顺序，模块必须是包含源代码的Python模块。

所以在conf.py文件中的某处，放置：

autodoc_member_order = 'bysource'

Answer 2

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

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

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