如何在sphinx中包含模块-Java 学习之路

我一直在寻找这个问题的答案一个星期 . 希望你能帮我：

我正在使用Sphinx进行记录，这是我项目的结构：

-folder
    __init__
    -main_tool_folder
        __init__
        main.py
        -docs_folder
    -modulefolder
        __init__
        fileIwanttodocument

在我的main.py里面

sys.path.append('../')
from modulefolder.fileIwanttodocument import functionIneed

并且代码有效

说到Sphinx失败了（在我导入的行上出错）

在我的conf.py我用

sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(1, os.path.abspath('../../'))

并在code.rst

.. automodule:: main
   :members

.. automodule:: modulefolder.fileIwanttodocument
   :members:

我如何包含fileIwanttodocument.py？到目前为止，我发现的唯一方法是将其复制到main_tool_folder中，这就失去了创建模块的目的

1 回答

0
自己解决了！在conf.py之前
```
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(1, os.path.abspath('../../'))
```
我有

sys.path.insert(0, os.path.dirname(os.getcwd()))

这导致了问题 .

显然我正在做的方式是正确的！
回复于 2024-05-13T02:47:23+08:00

如何在sphinx中包含模块

1 回答

相关问题