python - Sphinx autodoc 找不到模块

Question

我是 sphinx 的新手，需要帮助来弄清楚为什么我会收到以下错误:

WARNING: autodoc: failed to import module 'employe_dao' from module 'models'; the following exception was raised:
No module named 'models'

我的项目结构是:

|--master_project
   |--sub_project
      |--docs
        |--build
        |--conf.py
        |--index.rst
        |--Makefile
        |--models.rst
        |--src.models.rst
        |--src.rst
      |--src
        |--models
          |--employee.py
          ...
        |--__init__.py
        |--data_extractor.py
        |--optimiser.py
    enter code here
        ...

这是来自 index.rst 的片段

...

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. automodule::src
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule::models
   :members:
   :undoc-members:
   :show-inheritance:

...

* :ref:`modindex`

我已经添加了 sys.path.insert(0, os.path.abspath('./sub_project'))并取消注释 import os, import sys在 conf.py正如 Sphinx: autodoc can`t import module 中所推荐的那样

sphinx-build fail - autodoc can't import/find module @ryandillan 建议添加 sys.path.insert(0, os.path.abspath('..'))至 config.py修复了 model index 的 404“未找到索引” 错误对于 index.rst

我已经添加了 extensions = ['sphinx.ext.autodoc']至 config.py正如另一个 stackoverflow 线程中的建议。

关于我做错了什么还有什么建议吗？

Answer 1

根据您的目录结构，要添加到 sys.path 的目录应该是 ../src

要获得更一般的答案，请考虑如果您想在 Python CLI 中成功import module，您需要在哪个目录中。该目录是您希望 Sphinx 在您的路径中的目录。