通过 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