Question

您好我正在使用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中设置了狮身人面像：

 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:

2

 .. automodule:: fabfile
    :members:

如果我将fabfile移动到app1并使用app1.fabfile

，则第二个工作

我猜我的conf.py存在一些问题，但我尝试了许多推导但我无法导入我的fabfile.py，除非它位于app dir下（尽管在/funproject之下）也不起作用）。

非常感谢任何帮助。

Answer 1

您可以尝试使用fabric fabfile目录样式吗？也许是自动模块没有查看单个文件模块的情况？另一种风格的文档是here

Sphinx autodoc不导入模块

1 个答案: