首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >Sphinx autodoc不导入模块

Sphinx autodoc不导入模块
EN

Stack Overflow用户
提问于 2013-03-16 03:29:31
回答 1查看 464关注 0票数 2

嗨,我正在为一个使用sphinx的Django项目写一些文档。

我的项目(Django 1.4)如下所示:

代码语言:javascript
复制
/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:

代码语言:javascript
复制
 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源文件中,我可以这样做:

代码语言:javascript
复制
 .. automodule:: app1.models
    :members: 

它工作得很好。但是,这两个示例不起作用:

1.

代码语言:javascript
复制
 .. automodule:: funproject.models
    :members: 

2.

代码语言:javascript
复制
 .. automodule:: fabfile
    :members: 

如果我将文件移到app1中并使用app1.fabfile,则第二种方法可以正常工作

我猜我的conf.py有一些问题,但我已经尝试了很多派生,但我不能导入我的fabfile.py,除非它在应用程序目录下(尽管在/funproject下它也不能工作)。

这方面的任何帮助都将不胜感激。

EN

回答 1

Stack Overflow用户

发布于 2013-12-28 14:41:24

您可能会尝试使用fabric fabfile目录样式?也许是automodule不看单个文件模块的情况?另一种样式的文档是here

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/15440635

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档