2

我有经典的 Python 包结构:

bin/
    my_script
docs/
my_package/
   ...

我用 Sphinx 创建文档。

我想my_script自动获取文档字符串。有什么办法吗?

为什么要我这样做?我在这个脚本中有使用信息,我想在文档中显示它。

4

1 回答 1

2

我的解决方案 - 我认为这不是最好的。

__init__.py在 bin 目录中创建并符号链接my_script.pymy_script. 进入conf.py(狮身人面像的配置)我添加:

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

现在我可以使用自动模块:

.. automodule:: bin.my_script
于 2013-03-23T13:29:28.413 回答