微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

修复 Sphinx 和 Python 路径的问题

如何解决修复 Sphinx 和 Python 路径的问题

我有一个结构: 文件夹“LDS”:[文档 LDS codefolder2 codefolder3 ..] 在 'docs' 文件夹中,我正在创建 Sphinx 对象 sphinx-quickstart --ext-autodoc

文件 conf.py 中,我取消注释 sys.path.insert(0,os.path.abspath('..')) 我不确定我们是否需要 abspath 中的两个点。

文件 index.rst 中,我添加关键字 modules:caption: Contents: modules 从行首起三个空格

然后在终端我写sphinx-apidoc -o . ..。那行得通。

但是在 make html 之后,一切都是红色的

WARNING: autodoc: Failed to import module 'LDS.ts' from module 'LDS'; the following exception was raised:
No module named 'LDS.LDS'

有 2 个 LDS 文件夹,正如您从我问题开头的方案中看到的那样。但是所有代码都设计为从更大的代码内部运行。所以这意味着例如:如果我想运行 LDS.ts 那么我运行 python LDS.ts

由于主文件夹,

Sphinx 向其中添加LDS.LDS。这就是它可能不起作用的原因。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。