web-dev-qa-db-ja.com

Python-Sphinx出力をアルファベット順に並べ替えない方法

Sphinx for Pythonを使用すると、すべてのメソッド/関数名がHTMLでアルファベット順にソートされないようにするにはどうすればよいですか？ソースコードにあるのとまったく同じ順序に保ちたいです。

pythonpython-sphinx
21
Alex Poca

sphinx.ext.autodocドキュメント から：

autodoc_member_order

この値は、自動的に文書化されたメンバーをアルファベット順（値 'alphabetical'）、メンバータイプ（値 'groupwise'）、またはソース順（値 'bysource'）のいずれでソートするかを選択します。デフォルトはアルファベット順です。

ソースの順序については、モジュールはPythonモジュールであり、ソースコードが利用可能である必要があることに注意してください。

したがって、conf.pyファイルのどこかに次のように記述します。

autodoc_member_order = 'bysource'
35
James Scholes

単一の場合.rstファイル（最後の文字列を監視）：

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

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