问题描述
我写了一个包,叫它 MAUDIE。同样在包含 MAUDIE 模块的文件夹中,我有一个包含 sphinx 文档的 docs
文件夹和一个 tutorial
文件夹。在 tutorial
文件夹中,我有一个文件 use_Maudie.py
,它是一个在命令行运行基本用例的脚本,带有函数 use_maudie()
。
我想在我的文档中包含来自 use_maudie()
的文档字符串,并尝试了以下操作:
.. currentmodule:: MAUDIE.tutorial.use_Maudie
.. autofunction:: use_maudie
这(可能很明显)不起作用,因为没有模块 MAUDIE.tutorial。
有没有办法包含 use_maudie()
文档字符串的格式化版本,并且仍然将 use_Maudie.py
保留在 tutorial
文件夹中?
解决方法
暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!
如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。
小编邮箱:dio#foxmail.com (将#修改为@)