python - Pydoc に関数を特定の順序で文書化する方法は?

Question

Pydoc が関数を文書化する順序を指定したいと考えています。生成されたドキュメントで Pydoc が関数をどのように順序付けているかはわかりません。モジュール内のテキストの順序ではないことは確かです。

printUsage()最初にドキュメント化する関数を指定したいので、これは便利です。

"""
Sample module docstring
"""

def printUsage():
    """
    Command line usage: python my_module.py -i path/to/input_file.c
    If calling my_function() directly, pass the path/to/input_file.c as an arg.
    """
    print(printUsage.__doc__)

...

そのため、ユーザーが の docstring をチェックアウトすると、そのmy_module使用方法をすぐに確認できます。

Answer 1

ソースコードを見る：

モジュールのドキュメントは dict として保存されているように見えるため、それらを反復処理すると、ランダムな順序が作成されます。

def namelink(self, name, *dicts):
    """Make a link for an identifier, given name-to-URL mappings."""
    for dict in dicts:
        if name in dict:
            return '<a href="%s">%s</a>' % (dict[name], name)