On 4/18/06, Robin Haswell <[EMAIL PROTECTED]> wrote:
> For my 0.02 I think this should be done in some out-of-the-box Wiki
> software. That way you can link relevant articles together (one of PHP's
> strong points) and people can provide comments and examples (another one
> of PHP's strong points). Even if it's just temporary for the sprint - we
> can CnP articles into another format later if necessary. I do think a
> structured wiki is the way to go for this though. Maybe we could even
> hash out a TG app for this before the 29th? It'll only take 20 minutes,
> right? ;-)

I have yet to see a wiki that handles software project versions well
(ie the TG 0.8 to 0.9 move). That's the point of Docudo, which is
backed by Subversion and has that specific goal in mind.

For now, the site comes from Kid templates in Subversion.

> I really would like to lend a hand on this but I'm afraid every line of
> Python I write at the moment should be going in to my £5,000 project due
> in a month's time so I can pay off my car and buy a laptop. Although my
> productivity is being hampered by NOT having a laptop so this is really
> chicken/egg right now...

I know the feeling :)

> So anyway. Trac is bad because it's not for documentation. Wikis are
> good because they're fast and collaborative. xHTML is bad because it's a
> medium, not a tool.

But Trac *is* a wiki (plus bug tracker, source browser). The tool I
use for editing TurboGears docs is TextMate and it works very well.
(Global search and replace is nice plus, since the docs are Kid
templates, I make use of py:def in a couple of places to avoid
repeating myself.)

> One more point - is any work going to go in to docstrings through all of
> this? I can't help but notice how bloody annoying it is to find out what
> keywords methods accept, only to find myself tracing back through the
> inheritance tree to find **kw...

Yes, that's an important thing. Fredrik Lundh has taken care of some
things I wanted for PythonDoc, so we can get moving on having proper
docstrings and generated API docs.

Kevin

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"TurboGears" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at http://groups.google.com/group/turbogears
-~----------~----~----~----~------~----~------~--~---

Reply via email to