如何解决如何对模块外的文件使用 Sphinx 自动功能
我写了一个包,叫它 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 举报,一经查实,本站将立刻删除。