将Sphinx与Django一起使用时出现Autodoc错误

问题描述 投票:0回答:1

我正在尝试在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'

有什么建议吗?这是我的狮身人面像配置问题,还是django项目问题?

python django python-3.x python-sphinx
1个回答
0
投票

更改模型。rst看起来像:

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

已解决问题。

© www.soinside.com 2019 - 2024. All rights reserved.