[英]Documenting module/class/function bodies in Python Sphinx docs
Sphinx 文檔有沒有辦法使用 autodoc 功能輸出函數或類體(代碼本身)? 我使用 autodoc 取得了很大的成功。 除了文檔字符串被拉入文檔之外,我想要一個鏈接,點擊每個函數,它會顯示源代碼......這可能嗎?
這就是我的大部分文檔現在的樣子:
.. module:`foo.mymodule`
Title
===================
.. automodule:: foo.mymodule
.. autoclass:: MyModulesClass
:members:
:undoc-members:
如果這仍然很重要: viewcode 擴展可以做到這一點,但需要 Sphinx 的開發版本 (1.0)
我不相信。 Autodoc 僅用於從源代碼中提取文檔。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.