python - 在 Django 中使用 Sphinx 时出现 Autodoc 错误

Question

我正在尝试在 Django 项目中使用 sphinx autodoc，但一直收到相同的错误。我的项目结构有点像这样：

|project
|---app
|------models.py
|---docs
|------build
|------source
|---------conf.py
|etc

我的 conf.py 文件的顶部如下所示：

import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
from django.conf import settings
settings.configure()

我的 models.rst 文件如下所示：

Models
======
.. automodule:: project.app.models
    :members:

但是，每当我运行时make html，我都会收到一行错误：

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

有什么建议么？这是我的 sphinx 配置的问题，还是 django 项目的问题？

标签： pythondjangopython-3.xpython-sphinx

Answer 1

将我的 models.rst 更改为：

Models
======
.. automodule:: app.models
    :members:

解决了这个问题。