classification
Title: Add support to pydoc to output .rst restructured text
Type: enhancement Stage:
Components: Demos and Tools Versions:
process
Status: closed Resolution: rejected
Dependencies: Superseder:
Assigned To: Nosy List: georg.brandl, gregory.p.smith, r.david.murray
Priority: low Keywords:

Created on 2009-05-01 07:01 by gregory.p.smith, last changed 2009-05-01 18:55 by georg.brandl. This issue is now closed.

Messages (4)
msg86866 - (view) Author: Gregory P. Smith (gregory.p.smith) * (Python committer) Date: 2009-05-01 07:01
When writing documentation for a module that is already well documented
in its docstrings, I really wish pydoc could output .rst directly.

It'd mean much less manual editing.
msg86885 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2009-05-01 13:27
Personally I think that the Sphinx autodoc extension does a better job
of this than having pydoc export .rst would.  Is there some regard in
which that doesn't solve your problem?
msg86890 - (view) Author: Gregory P. Smith (gregory.p.smith) * (Python committer) Date: 2009-05-01 17:10
oh. sphinx can already do this?  nevermind then.

*goes off to look closer at sphinx*
msg86894 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-05-01 18:55
I'd like to note that what Sphinx can't do -- or better, doesn't do at
the moment, is to output full reStructuredText documents when using
autodoc.  It directly integrates the docstrings into the doctree that
will become the output.

So, for the Python documentation itself, where we do not want to use
autodoc (it would be nice, but would require that the documentation be
built using the version of Python that is documented, which is e.g.
currently impossible in the case of 3.x), this is of no great help.
History
Date User Action Args
2009-05-01 18:55:04georg.brandlsetnosy: + georg.brandl
messages: + msg86894
2009-05-01 17:10:46gregory.p.smithsetstatus: open -> closed
resolution: rejected
messages: + msg86890
2009-05-01 13:27:07r.david.murraysetpriority: normal -> low
nosy: + r.david.murray
messages: + msg86885

2009-05-01 07:01:25gregory.p.smithcreate