[ python-Bugs-1000301 ] Cajole epydoc or other into giving output suitable for forrest

[noreply at pgfoundry.org]

Bugs item #1000301, was opened at 2005-04-28 01:55
You can respond by visiting: 
http://pgfoundry.org/tracker/?func=detail&atid=442&aid=1000301&group_id=1000094

Category: Documentation
Group: To do
>Status: Closed
Resolution: Accepted
Priority: 2
Submitted By: James Pye (jwp)
Assigned to: James Pye (jwp)
Summary: Cajole epydoc or other into giving output suitable for forrest

Initial Comment:
Serving up the HTML output from epydoc is fine, but it is not seamless. Having it generate Apache Documentation 2.0 or DocBook 5.0 would give something that could be worked with.

The API reference should have a seperate section from the documentation on the site, as the documentation is meant to be official. Also, the current infrastructure there on /web depends on the docs being specially generated from /doc.

----------------------------------------------------------------------

>Comment By: James Pye (jwp)
Date: 2008-01-05 22:25

Message:
I'm not going to use forrest for the module documentation. It seems more painful than useful. I'm thinking about just doing raw uploads of generated pydoc html into a directory structure:

http://python.projects.postgresql.orgs/docs/pg_proboscis/0.9/postgresql.interface.proboscis.greentrunk

Something simple. :)

----------------------------------------------------------------------

Comment By: James Pye (jwp)
Date: 2006-02-12 22:13

Message:
The appendix portion of the documentation is a fantastic place for reference material. Currently, the data there was entered by hand. This is painful and unnecessary. However, each section will likely need a custom generator to suite the specific aspects of the objects.

----------------------------------------------------------------------

You can respond by visiting: 
http://pgfoundry.org/tracker/?func=detail&atid=442&aid=1000301&group_id=1000094