我有经典的Python包结构:
bin/
my_script
docs/
my_package/
...
我使用 Sphinx 创建文档。
我想自动从 my_script 获取文档字符串。有什么办法可以做到吗？
为什么要我这么做？我在此脚本中有使用信息，我想在文档中显示它。
最佳答案
我的解决方案 - 我认为这不是最好的。
我在bin目录中创建了__init__.py，并将my_script.py符号链接(symbolic link)到my_script。在 conf.py (sphinx 的配置)中我添加了:
sys.path.insert(0, os.path.abspath('..'))
现在我可以使用自动模块了:
.. automodule:: bin.my_script
关于python - 通过 Sphinx 从脚本中获取文档字符串，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/15587125/