sphinx-doc/sphinx

Autodoc should output generated rst

Open

#2953 opened on Sep 13, 2016

View on GitHub
 (3 comments) (11 reactions) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
extensions:autodochelp wantedtype:proposal

Description

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?

Contributor guide

Tech stack
python
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonSphinx internalsautodoc/autosummary modules
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.