Pythondocs.info : collaborative Python documentation project

Brad Allen bolderaft at gmail.com
Sun Sep 17 18:28:42 EDT 2006


A.M. Kuchling wrote:
> However, this code isn't used at the moment because I have no idea
> what to do about version controlling the links.  Do we just use the
> current links whenever the HTML is generated?  Make a copy of the list
> and commit them into SVN, so the links cease to be updated but are
> consistent for a given version's docs?  It would be nice to figure out
> what to do.

That sounds like another good reason to handle the examples at
python.org, but it argues against a wiki approach for examples. Maybe
the examples should be part of the same SVN repository; if they are
implemented as doctests they can be validated before each new release.
On the other hand, that probably only works for very simple examples;
I've seen some extensive examples at in the Cookbook that might not fit
well into a doctest.

There could a separate tab for "Links" alongside tabs for
documentation, svn source, doctests, discussion, bugs/requests, wiki.
The links tab might have a disclaimer to the effect of "Your Mileage
May Vary", and each link might have  a date posted next to it. The
links might not all be examples; they could point to alternative tools,
related resources, more discussion -- whatever the community comes up
with. Eventually, someone would have to prune; the dates would help
with that. Also, if folks could rate the links, the best ones might
float to the top.




More information about the Python-list mailing list