2013-06-13 24 views
3

就狮身人面像而言,我是一个新手。我的项目结构如下:如何为狮身人面像定制模块名称

  • argparse_actions/
    • argparse_actions/
      • __init__.py
      • folder_actions.py
      • ip_actions.py
    • DOC/
      • _build/
      • index.rst ==>这是起点,主页或根文档。
      • 更多...

__init__.py看起来是这样的:

from folder_actions import * 
from ip_actions import * 

folder_actions.py看起来是这样的:

''' 
Folder Actions 
============== 

This module implements some reusable custom actions. 

.. autoclass:: FolderExistsAction 
.. autoclass:: FolderCreateAction 
    :members: 

''' 

# The rest of the code 

基因评级的HTML文件看起来很好,除了这部分:

folder_actionsFolderCreateAction(...)

我知道folder_actions模块前缀是正确的,但我想改变它使用包名称,而不是像这样:argparse_actions

类。 FolderCreateAction(...)

有没有办法让我实现这个目标?

更新

  • 根文件是doc/index.rst
  • 如果我移动文档字符串从folder_actions.py__init__.py,那么文档将是这样的:

    class __init__.FolderCreateAction(...) 
    
  • 仅供参考,我的项目已开启BitBucket

更新2

我不知道为什么我的更改没有推送到BitBucket,但是不相关。请看看同一个项目,推到GitHub。感谢您的帮助,mzjn

+0

1.您必须在'doc'中至少有一个.rst文件。里边啥啊? 2.如果将模块docstring从'folder_actions.py'移动到'__init __。py',会发生什么? – mzjn

+0

请参阅我的更新。 –

+0

请参阅我的更新2.谢谢,@ mzjn。 –

回答

1

裂孔几个月后,终于想出了解决方案:通过将下面的行的folder_actions.pyip_action.py模块的文档字符串:

.. module:: argparse_actions 

优选地,该线应的第一行模块文档字符串。