2

私は古典的なPythonパッケージ構造を持っています：

bin/
    my_script
docs/
my_package/
   ...

そして私はSphinxでドキュメントを作成します。

my_script自動的にdocstringを取得したいのですが。それを行う方法はありますか？

なぜ私はそれをしたいのですか？このスクリプトに使用法の情報があり、ドキュメントに表示したいと思います。

4

1 に答える 1

2

私の解決策-私はそれが最善だとは思いません。

__init__.pybinディレクトリに作成し、へのシンボリックリンクを作成しましmy_script.pyたmy_script。（スフィンクスconf.pyの構成）に追加しました：

sys.path.insert(0, os.path.abspath('..'))

これで、自動モジュールを使用できます。

.. automodule:: bin.my_script
于 2013-03-23T13:29:28.413 に答える