[Python-Dev] Moving the developer docs?

Antoine Pitrou solipsis at pitrou.net
Thu Sep 23 16:31:47 CEST 2010

On Thu, 23 Sep 2010 10:16:01 -0400
"R. David Murray" <rdmurray at bitdance.com> wrote:
> On Thu, 23 Sep 2010 23:35:02 +1000, Nick Coghlan <ncoghlan at gmail.com> wrote:
> > On Thu, Sep 23, 2010 at 8:11 PM, Antoine Pitrou <solipsis at pitrou.net> wrote:
> > > The practicality argument of being able to edit those docs without
> > > having to master a separate (pydotorg) workflow sounds quite strong to
> > > me.
> > 
> > This is the key point for me. For developer controlled stuff, the
> > easiest place to have it if we want it kept up to date is in the
> > source tree. Second best is the wiki. Having it off in a separately
> > managed repository (that exists for perfectly valid reasons, since a
> > lot of the content *isn't* developer controlled) is annoying.
> > 
> > That said, in this case, what's the advantage of the source tree over
> > the wiki? To include it in the main docs, so people reading them
> > offline can still see the contribution workflow?
> I'd *much* rather edit rst files than futz with a web interface when
> editing docs.  The wiki also somehow feels "less official".

I agree with the "less official" point. If our developer docs feel
authoritative, people will be more encouraged to contribute.

Also, the wiki in its current state looks much less polished than the
Sphinx-generated docs.



More information about the Python-Dev mailing list