通過 Sphinx 從腳本中獲取文檔字符串

Question

我有經典的 Python 包結構：

bin/
    my_script
docs/
my_package/
   ...

我用 Sphinx 創建文檔。

我想自動從my_script獲取文檔字符串。 有什么辦法嗎？

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

Answer 1

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

我在 bin 目錄中創建了__init__.py並將my_script.py符號鏈接到my_script 。 在conf.py (sphinx 的配置) 中，我添加了：

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

現在我可以使用自動模塊：

.. automodule:: bin.my_script