docstring

2熱度

1回答

在IRB或其他交互式解釋程序（如pry）中，如何獲取有關對象和方法的內聯文檔？例如，我可以走這麼遠： [1] pry(main)> x = 'hello world' => "hello world" [2] pry(main)> x.st x.start_with? x.strip x.strip! [2] pry(main)> x.st 但現在我想讀的使用/接口/不管的RDoc不

0熱度

1回答

從docstring查找python文件的作者

我試圖編寫一個程序，該程序具有通過在文檔字符串中查找Author字符串來查找和打印文件作者的功能。我已經設法得到下面的代碼來打印一個文件的作者，該文件的作者字符串後面跟着作者姓名，作者字符串後面跟着一個名字。我遇到的問題是當作者字符串根本不存在時試圖打印Unknown，即文檔字符串的任何部分都不包含Author。 N.B. lines只是在文件上使用readlines()構建的列表。 def au

5熱度

1回答

在Python中的規範方式來添加或檢索元數據信息/從文檔字符串？

我想添加一些元信息到我的Python模塊的文檔，比如作者，電子郵件，版本。有沒有規範的方法來做到這一點？我搜索了很長時間，但在這裏或網絡上找不到具有明確權限的任何內容。 PEP 426 -- Metadata for Python Software Packages 2.0談了一番。它看起來像__author__,__version__和其他一些pydoc（V2.7）。此外，還有epydoc和sp

7熱度

1回答

如何讓獅身人面像在我的文檔字符串中忽略GPL通知？

我正在使用Sphinx來記錄我的Python包。當我在我的模塊上使用automodule指令時： .. automodule:: mymodule :members: 它打印包括GPL通知在內的所有文檔字符串。有什麼辦法可以告訴Sphinx忽略文檔字符串/ GPL，還是應該將它保留在文檔中？

11熱度

3回答

在Django RestFramework中，如何更改Api Root文檔？

在django RestFramework中，是否有任何「官方」方式來生成「Api Root」的文檔？ from rest_framework import routers class MyRouter(routers.DefaultRouter): def get_api_root_view(self): api_root_view = super(MyRouter,

0熱度

1回答

在python中，如何打印導入模塊中定義的所有函數的文檔字符串，而不導入導入模塊本身導入的函數？

以下代碼從導入的模塊打印每個函數的文檔字符串。然而，結果包含了一些在模塊中沒有定義的功能，而是由模塊導入。 import inspect import my_module all_functions = inspect.getmembers(my_module, inspect.isfunction) for i in all_functions: print i[0] #

4熱度

1回答

在sphinx python中的Mathjax表達式不呈現correclty

我一直在試圖弄清楚這個表達式在我的文檔字符串中有什麼問題。我在python sphinx v1.2b中使用sphinx.ext.mathjax擴展。文檔字符串： .. math:: w_k^* = \min_{w_k} \ell_k(w_k) + \lambda\left(\alpha||w_k||_1 + \frac{1}{2}(1-\alpha) ||w_k||^2\ri

5熱度

2回答

Python 3 - 不破壞裝飾器或違反DRY的方法docstring繼承

這個問題似乎定期出現在StackOverflow和其他地方，但我無法在任何地方找到完全令人滿意的解決方案。似乎有兩種常見的解決方案。第一個（例如從http://article.gmane.org/gmane.comp.python.general/630549）使用函數裝飾： class SuperClass: def my_method(self): '''Has a d

4熱度

1回答

NumPy如何處理文檔到參數的sphinx文檔中？

我想用獅身人面像建造我們的文檔，並獲得參數作爲NumPy的文檔（https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt）我發現兩種方式與獅身人面像這第一個風格記錄參數，其中一個是 :param name: description 相同的格式或 :keyword name: description ，另一個

14熱度

1回答

標準庫中的PEP 257文檔字符串修剪？

PEP 257說：文檔字符串處理工具將剝離從文檔字符串的第二和進一步的線，等於第一行之後的所有非空行的最小凹陷壓痕均勻量。文檔字符串的第一行（即，直到第一個換行符）的任何縮進都是不重要的，並且被刪除。保留文檔字符串中後面行的相對縮進。空白行應從文檔字符串的開頭和結尾刪除。然後在PEP中顯示實現該算法的功能trim。我可以找到問題，其中人們問如何格式化文檔，並提到PEP 257（例如，this