找獅身人面像

Question

從腳本文檔字符串我有古典Python包結構：

bin/ 
    my_script 
docs/ 
my_package/ 
    ... 

，我創建獅身人面像的文檔。

我想自動取my_script的文檔串。有什麼辦法可以做到嗎？

爲什麼我要這樣做？我在這個腳本中有使用信息，我想在文檔中顯示它。

Answer 1

我的解決方案 - 我不認爲這是最好的。

我在bin目錄中創建了__init__.py，並在符號鏈接my_script.py到my_script之間創建了__init__.py。到conf.py（獅身人面像的配置），我說：

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

現在我可以用automodule：

.. automodule:: bin.my_script