2

次のように、Python モジュールで変数を文書化したとします。

some_random_name = 'whatever'
"""The random whatever variable"""

モジュール文字列をドラッグしてドキュメント出力を生成することなく、.rst ファイルにその単一変数の autodoc を含めることはできますか?__doc__

私が試してみました

.. automodule: themodule
   :members: some_random_name

ただし、両方とも__doc__文字列をドラッグし、 の autodocs を表示しませんsome_random_name。

4

1 に答える 1

2

モジュール属性の文書化に関する問題を再現できません。わたしにはできる。たまたま__all__、値に含まれていない変数がモジュールにありますsome_random_nameか？Sphinxは __all__、メンバーを探すときに考慮します。

モジュールdocstringは、autodoc-process-docstringイベントをインターセプトすることで削除できます。これがデモンストレーションです（コードをconf.pyに追加します）：

import inspect

def remove_mod_docstring(app, what, name, obj, options, lines):
    """Erase module docstring in-place"""  
    if inspect.ismodule(obj):
        for i in xrange(len(lines)):
            lines[i] = ''

def setup(app):
    app.connect('autodoc-process-docstring', remove_mod_docstring)
于 2013-01-22T22:23:16.093 に答える