修复 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 (将#修改为@）