有無獅身人面像識別進口類和函數，而不是模塊

Question

假設我有以下結構的項目：

mypackage 
├── mypackage 
│ ├── __init__.py 
│ ├── someclass.py 
│ └── somefunction.py 
└── setup.py 

然後，我有__init__.py爲：

from mypackage.someclass import someclass 
from mypackage.somefunction import somefunction 

而且someclass.py爲：

class Someclass: 
... 

and somefunction.py as：

def somefunction: 
... 

這是不可能的「隱藏」從用戶的所以只有mypackage.Someclass和mypackage.somefunction可mypackage.someclass.Someclass和mypackage.somefunction.somefunction，對不對？

但問題是，獅身人面像實際documentating mypackage.someclass.Someclass和mypackage.somefunction.somefunction代替mypackage.Someclass和mypackage.somefunction。

並且在mypackage.somefunction.somefunction的情況下，如果我導入mypackage，這是非常糟糕的，因此無法訪問。

那麼，有可能有獅身人面像文件mypackage.Someclass和mypackage.somefunction？根據我在其他答案中讀到的內容，可以通過編輯__module__或使用autoclass來完成，但我目前無法完成此操作。

Answer 1

使用autoclass，如Sphinx文檔sphinx.ext.autodoc – Include documentation from docstrings中所述。

爲了使autoclass（和其他autodoc功能）正常工作，模塊必須是可導入的。

autodoc將記錄您的模塊的API，並且您可以添加reStructuredText格式的docstrings作爲敘述文檔來解釋使用情況。

在您的軟件包目錄旁邊有一個docs目錄是個好主意。

mypackage 
├── docs 
│ ├── conf.py 
│ ├── other sphinx stuff 
│ └── index.rst 
├── mypackage 
│ ├── __init__.py 
│ ├── someclass.py 
│ └── somefunction.py 
└── setup.py 

組織內docs您.rst文件。你的模塊是一個API，所以你可以組織你的.rst文件，像這樣：

mypackage 
├── docs 
    └── api 
     ├── someclass.rst 
     └── somefunction.rst 

在每一個在api目錄中的文件，使用適當的語法。

.. autoclass:: someclass 
.. autofunction:: somefunction 

上述Sphinx文檔中還有幾個選項。