sphinx-doc/sphinx

Autodoc should output generated rst

Open

#2,953 建立於 2016年9月13日

在 GitHub 查看
 (3 留言) (11 反應) (0 負責人)Python (5,625 star) (1,985 fork)batch import
extensions:autodochelp wantedtype:proposal

描述

When using autodoc or autosummary, the generated rst is never saved as far as I can tell. So if you go to a page that was generated with autosummary, like this: http://scikit-learn.org/dev/modules/generated/sklearn.cluster.DBSCAN.html#sklearn.cluster.DBSCAN

and you click "show this page's source" you'll just get the autosummary template: http://scikit-learn.org/dev/_sources/modules/generated/sklearn.cluster.DBSCAN.txt

That's not very helpful for debugging. I think storing the generated RST would be more helpful, possibly optionally?

貢獻者指南

技術棧
python
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
PythonSphinx internalsautodoc/autosummary modules
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
Investigate Sphinx's autodoc and autosummary extensions to identify where the generated RST content is produced but not written to disk. This likely involves modifying the builder or event handlers to optionally save the intermediate RST. Check existing comments for any prior attempts or discussion. A minimal implementation could add a configuration option to enable saving of generated RST files for debugging purposes.