Sphinx with Django - Model没有声明显式的应用程序标签

Question

我已经花了无数个小时，但它仍然卡住了。文档是如此的缺乏。使用Django 1.10，尝试创建Sphinx文档，它已经给出了各种错误。我终于被困在这里了。我在我的主应用程序kyc_connect中创建了一个示例模型，如下所示。

Models.py

from django.db import models
class example(models.Model):        
    filed1 = models.DateTimeField(auto_now=True)

    # class Meta:
    #     app_label = 'kyc_connect'

运行make_html时会出现以下错误。

RuntimeError: Model class kyc_connect.models.example doesn't declare an explicit app_label and isn't in an application in INSTALLED_APPS.

Conf.py导入设置

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

当我包含当前注释掉的Meta类时，这个错误就消失了。但是如果我在ForeignKey中包含一个模型并导入from django.contrib.auth.models import User，它会给出错误RuntimeError: Model class django.contrib.contenttypes.models.ContentType doesn't declare an explicit app_label and isn't in an application in INSTALLED_APPS.

INSTALLED_APPS

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework_swagger',
    'rest_framework',
    'rest_framework.authtoken',
    'kyc_connect',
    'kyc_connect_data_models',
    'kyc_rest_services.kyc_connect_accounts',
    'kyc_rest_services.kyc_connect_documents',
    'kyc_rest_services.kyc_connect_transaction_manager',
    'tasks',
    'elasticstack',
    'corsheaders',
    'haystack'
]

ProjectStructure

kyc_connect:
  -config
  -docs
  -kyc_connect
    -models.py
    .
    .
  -kyc_connect_data_models
  -kyc_core
  -kyc_rest_services
    -kyc_connect_accounts
    -kyc_connect_transaction_manager
    .
    .
  .
  .

我在那里已经有django.contrib.contentype了。但是django似乎不理解。我不想声明meta类。哪里出了问题。任何帮助都是最好的。

Answer 1

我在我的项目中遇到了同样的问题，最终通过删除conf.py文件中的settings.configure()并运行以下命令来解决它

make clean
make html

在我的docs目录中。

Answer 2

我在我的项目中也犯了同样的错误。我通过更改在所有应用程序文件中导入模型的方式解决了这个问题。例如，在admin.py change中注册模型

from project.app.models import YourModel

为了..。

from .models import Your.Model

Answer 3

对于还在这个问题上苦苦挣扎的其他人来说，这可能会有所帮助：

请注意以下几点：

.. automodule:: appName.models

而不是像这样的东西：

.. automodule:: ProjectName.appName.models

如果像我一样，出于某些原因，您希望将您的docs目录放在django根目录的父文件夹中，则可以附加该目录。

注意：为了正常工作，我的视图和任务必须设置为：

.. automodule:: ProjectName.appName.tasks
.. automodule:: ProjectName.appName.views

希望它能节省时间。