如何在Python中添加作者爲NumPy文檔字符串

我們從Sphinx轉換爲樣式NumPy文檔字符串和.. sectionauthor::似乎不再正確呈現。但是，我們需要能夠將作者分配給每個類的方法。如何在Python中添加作者爲NumPy文檔字符串

有沒有辦法將作者身份添加到NumPy文檔字符串中？

幼稚例如：

class A: 
    def f(self): 
     """ My function 

     It does this and that. 

     Returns 
     ------- 
     object 

     .. sectionauthor:: name of the author 

     Examples 
     -------- 
      >>> A().f() 

     """ 
     pass

編譯成這個幫助文檔（通知困擾回報：部分）：

P.S.在NumPy文檔字符串中使用.. sectionauthor::在其他地方被提出（無法回想起源代碼），所以也許它不被正確地使用/放置。

來源

2015-11-27 Oleg Melnikov

。我不知道'numpy'有自己的風格或渲染引擎（與Python'docstring'不同）。 – hpaulj

渲染是內置在PyCharm中的，但我不知道PyCharm使用什麼軟件包。它通過快速文檔工具（或CTRL + Q）完成，並生成一個html（我認爲）輸出，它顯示在上面的printscreen中。 –

好的，這是'reStructuredText'中的元數據，可能是由'docutils'渲染的。 – hpaulj

想通了......

首先，NumPy style documentation鼓勵加入作者的信息，以文檔字符串：「注意許可證和作者信息，而通常包含在源文件中，不屬於文檔字符串。「

也就是說，在文檔中直接標識作者並不少見（請參閱R語言中的函數/方法的任何幫助手冊）。

儘管如此，必有一個需要添加的作者，這可以用:Authors:reStructured inline markup標籤來完成，如下：

:Authors: 
    John Doe <[email protected]>

由於發現的，它的位置是有限的。 :Authors:似乎仍然正確渲染文檔字符串，如果放置在描述，參數和返回部分之外;例如Examples部分之後。

這是一個持續的例子：

你在使用渲染`docstring`

來源

2015-11-27 22:40:59

這是numpy的一個角落，我沒有多加註意，雖然我一直在閱讀功能文檔。 – hpaulj

我也學到了新東西:) –

如何在Python中添加作者爲NumPy文檔字符串

回答

相關問題