sphinx-doc/sphinx

Autodoc should output generated rst

Open

#2,953 创建于 2016年9月13日

在 GitHub 查看
 (3 评论) (11 反应) (0 负责人)Python (1,985 fork)batch import
extensions:autodochelp wantedtype:proposal

仓库指标

Star
 (5,625 star)
PR 合并指标
 (平均合并 10天 11小时) (30 天内合并 11 个 PR)

描述

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?

贡献者指南