Ticket #104 (new enhancement)

Opened 3 years ago

Last modified 1 month ago

Updated API reference toolchain

Reported by: grimmtooth@gmail.com Assigned to: splee
Priority: high Milestone: __unclassified__
Component: Web site Version: 1.0.4.3
Severity: normal Keywords:
Cc:

Description (Last modified by kevin)

I would like to generate API docs using either Epydoc or PythonDoc? (which both support attaching metadata about specific aspects of methods and source parsing, which allows documentation for object properties). I also really like having links to syntax highlighted source files, as Pudge provides or the current hacked epydoc provides.

PythonDoc? has the advantage in that it creates an infoset based on the data it collects. This makes it relatively easy to format things however we want. It currently has a limitation that it doesn't parse out the metadata tags from the docstrings, just from doc comments. I really want our docs in docstrings so that things like pydoc and help() work properly.

I'm not fond of Epydoc's multiframe appearance, and I don't think anyone else really is either. You can turn off the frames and adjust the CSS, and that may be enough customization.

So, the challenge here is to pick one of those two tools (Epydoc 3 or PythonDoc?) and then figure out the magic incantations/create templates and CSS to generate the API docs for TurboGears and everything in thirdparty except MochiKit?.

Change History

11/12/05 10:16:54 changed by kevin

  • milestone set to 0.9.

11/15/05 09:57:57 changed by kevin

  • component changed from TurboGears to Docs.

03/30/06 07:06:02 changed by kevin

  • type changed from defect to enhancement.
  • description changed.
  • summary changed from Some functions missing from TG API reference to Updated API reference toolchain.

05/31/06 00:44:51 changed by jorge.vargas

  • version deleted.
  • milestone changed from 0.9 to 1.0b1.

I believe Kevin in the docs sprint made an update to this, was that final? does it fixes this bug?

09/22/06 10:50:03 changed by khorn

milestone passed, changing to 1.0

I really think this should be done before 1.0 is released.

09/22/06 10:50:39 changed by khorn

  • milestone changed from 1.0b1 to 1.0.

09/27/06 02:33:08 changed by steve@holdenweb.com

It would be nice if documentation of *any* kind was available for the API. Currently the "API Reference" link on http://docs.turbogears.org/1.0 (which actually points to http://www.turbogears.org/preview/api) redirects to http://www.turbogears.org/previewdone.html, which tells me the preview is done and points me to the 1.0 docs, which don't appear to include API docs.

Help, I'm in a maze of twisty little passages all the same.

09/27/06 02:59:08 changed by steve@holdenweb.com

Further note: http://www.turbogears.org/docs/ also contains an API docs link, this time pointing to http://www.turbogears.org//api/index.html and (sorry) again broken.

01/12/07 06:27:55 changed by alberto

  • milestone changed from 1.0 to 1.1.

01/13/07 16:26:33 changed by jorge.vargas

got something working at

http://tg.maetico.com/api/

01/30/07 11:53:08 changed by jorge.vargas

  • owner changed from anonymous to splee.
  • priority changed from normal to high.
  • component changed from Docs to website.

here is the command I used to generate the api epydoc --o api -n TurboGears -u http://www.turbogears.org turbogears 2> error.log

eventually this could be replaced by the "apigen" package but we need to be sure this is the way we want to go.

03/28/07 12:42:00 changed by alberto

  • milestone changed from 1.1 to __unclassified__.

Batch moved into unclassified from 1.1 to properly track progress on the later

(in reply to: ↑ description ) 04/16/08 09:58:36 changed by lszyba1

  • version set to 1.0.4.3.

See http://lucasmanual.com/tgdocs/turbogears-module.html for epydoc documentation from TurbogGears? source.

Lucas