2013-06-13 52 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 

優選地,該線應的第一行模塊文檔字符串。