django Sphinx autodoc不导入模块

tct7dpnv  于 2023-11-20  发布在  Go
关注(0)|答案(1)|浏览(109)

我正在使用Sphinx为Django项目编写一些文档。
我的项目(Django 1.4)看起来像这样:

/funproject
   /documentation
       # this is where sphinx files live
       /source
           conf.py
           ... 
   /funproject
       __init__.py
       settings.py
       admin.py
       models.py
   /app1
   /app2
   fabfile.py
   manage.py

字符串
我在conf.py上安装了Sphinx:

import sys, os

 sys.path.append(os.path.join(os.path.dirname(__file__), '../..'))

 os.environ['DJANGO_SETTINGS_MODULE'] = 'funproject.settings'

 from funproject import settings
 from django.core.management import setup_environ
 setup_environ(settings)


所以在我的Sphinx源文件中,我可以这样做:

.. automodule:: app1.models
    :members:


这很好。但是,这两个例子不起作用:
1.

.. automodule:: funproject.models
    :members:

.. automodule:: fabfile
    :members:


如果我将fabfile移到app1中并使用app1.fabfile,则第二种方法有效
我猜我的conf.py有一些问题,但我已经尝试了许多派生,但我不能导入我的fabfile.py,除非它是在一个应用程序目录下(虽然在/funproject下它也不工作)。

9jyewag0

9jyewag01#

您可以尝试使用fabric fabfile目录样式?也许是因为automoController不查看单个文件模块的情况?关于其他样式的说明在这里

相关问题