在autodoc docstring中執行代碼

Question

當使用Sphinx和autodoc來記錄一個Python項目時，可以使用:Example:在你的模塊/類/函數docstring中包含一個代碼示例，Sphinx會爲你高亮顯示語法。像這樣的東西。

>>> rng = Range(0, 1000) 
>>> rng 
[0, 1000) 
>>> len(rng) 
1000 
>>> rng.start = 500 
>>> rng.start 
500 
>>> rng.end 
1000 
>>> 

我從Python解釋器複製並粘貼了它。有什麼辦法讓Sphinx或autodoc執行代碼並自動爲文檔捕獲輸出？

我主要關心的是複製粘貼代碼/輸出與實際當前代碼行爲不同步。

Answer 1

標準庫包括doctest，它可以從文本文件或文檔字符串中識別，執行和驗證交互式示例。